BudgetsComponents
Defined in: src/budgets/types.gen.ts:249
Properties
Section titled “Properties”headers
Section titled “headers”headers:
never
Defined in: src/budgets/types.gen.ts:985
parameters
Section titled “parameters”parameters:
never
Defined in: src/budgets/types.gen.ts:983
pathItems
Section titled “pathItems”pathItems:
never
Defined in: src/budgets/types.gen.ts:986
requestBodies
Section titled “requestBodies”requestBodies:
never
Defined in: src/budgets/types.gen.ts:984
responses
Section titled “responses”responses:
never
Defined in: src/budgets/types.gen.ts:982
schemas
Section titled “schemas”schemas:
object
Defined in: src/budgets/types.gen.ts:250
AuthorizationSettings
Section titled “AuthorizationSettings”AuthorizationSettings:
object
AuthorizationSettings.authorization_type
Section titled “AuthorizationSettings.authorization_type”authorization_type:
"HARD"|"SOFT"
AuthorizationSettings.base_limit
Section titled “AuthorizationSettings.base_limit”base_limit:
object
AuthorizationSettings.base_limit.amount
Section titled “AuthorizationSettings.base_limit.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”700AuthorizationSettings.base_limit.currency
Section titled “AuthorizationSettings.base_limit.currency”currency:
string|null
Description
Section titled “Description”The type of currency, in ISO 4217 format.
Default
Section titled “Default”USDExample
Section titled “Example”USDAuthorizationSettings.limit_buffer_percentage?
Section titled “AuthorizationSettings.limit_buffer_percentage?”
optionallimit_buffer_percentage?:number|null
Format: int32
Description
Section titled “Description”The percentage of flexible buffer on the limit as a 0-100 integer.
AuthorizationSettings.limit_with_increases
Section titled “AuthorizationSettings.limit_with_increases”limit_with_increases:
object
AuthorizationSettings.limit_with_increases.amount
Section titled “AuthorizationSettings.limit_with_increases.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”700AuthorizationSettings.limit_with_increases.currency
Section titled “AuthorizationSettings.limit_with_increases.currency”currency:
string|null
Description
Section titled “Description”The type of currency, in ISO 4217 format.
Default
Section titled “Default”USDExample
Section titled “Example”USDAuthorizationSettings.rollover_refresh_rate
Section titled “AuthorizationSettings.rollover_refresh_rate”rollover_refresh_rate:
"OFF"|"NEVER"|"PER_MONTH"|"PER_QUARTER"|"PER_YEAR"
AuthorizationType
Section titled “AuthorizationType”AuthorizationType:
"HARD"|"SOFT"
Description
Section titled “Description”Whether authorizations will decline based on available balance.
AuthorizationVisibility
Section titled “AuthorizationVisibility”AuthorizationVisibility:
"PUBLIC"|"PRIVATE"
Description
Section titled “Description”Describes if the limit of the Spend Limit is visible to all members, or just controllers, bookkeepers, and owners (direct or ancestral).
AutoCreateLimitCardsSetting
Section titled “AutoCreateLimitCardsSetting”AutoCreateLimitCardsSetting:
"DISABLED"|"ALL_MEMBERS"
Description
Section titled “Description”Setting for how auto limit card creation works for members.
AutoTransferCardsSetting
Section titled “AutoTransferCardsSetting”AutoTransferCardsSetting:
"DISABLED"|"ENABLED"
Description
Section titled “Description”Setting for how auto transfer works for virtual cards.
Budget
Section titled “Budget”Budget:
object
Budget.account_id
Section titled “Budget.account_id”account_id:
string
Description
Section titled “Description”The Brex account this Spend Limit belongs to.
Budget.budget_id
Section titled “Budget.budget_id”budget_id:
string
Description
Section titled “Description”Unique ID for the Spend Limit.
Budget.budget_status
Section titled “Budget.budget_status”budget_status:
"DELETED"|"APPROVED"|"EXPIRED"|"TERMINATED"
Budget.budget_type
Section titled “Budget.budget_type”budget_type:
"BUDGET"|"SPEND_LIMIT"
Budget.creator_user_id?
Section titled “Budget.creator_user_id?”
optionalcreator_user_id?:string|null
Description
Section titled “Description”The ID of the user who originally created this Spend Limit.
Budget.current_period_balance?
Section titled “Budget.current_period_balance?”
optionalcurrent_period_balance?: {balance?: {amount:number;currency:string|null; } |null;end_date?:string|null;start_date?:string|null; } |null
Union Members
Section titled “Union Members”Type Literal
Section titled “Type Literal”{ balance?: { amount: number; currency: string | null; } | null; end_date?: string | null; start_date?: string | null; }
balance?
Section titled “balance?”
optionalbalance?: {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
end_date?
Section titled “end_date?”
optionalend_date?:string|null
Format: date
start_date?
Section titled “start_date?”
optionalstart_date?:string|null
Format: date
null
Budget.description?
Section titled “Budget.description?”
optionaldescription?:string|null
Description
Section titled “Description”Description of what the Spend Limit is used for.
Budget.end_date?
Section titled “Budget.end_date?”
optionalend_date?:string|null
Format: date
Description
Section titled “Description”The UTC date when the Spend Limit should stop counting.
Budget.limit?
Section titled “Budget.limit?”
optionallimit?: {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
Budget.limit_type?
Section titled “Budget.limit_type?”
optionallimit_type?:"HARD"|"SOFT"|null
Budget.limit_visibility
Section titled “Budget.limit_visibility”limit_visibility:
"PRIVATE"|"SHARED"
Budget.member_user_ids
Section titled “Budget.member_user_ids”member_user_ids:
string[]
Description
Section titled “Description”User IDs of the members of the Spend Limit.
Budget.name
Section titled “Budget.name”name:
string
Description
Section titled “Description”Name for the Spend Limit.
Budget.owner_user_ids
Section titled “Budget.owner_user_ids”owner_user_ids:
string[]
Description
Section titled “Description”User IDs of the owners of the Spend Limit.
Budget.parent_budget_id?
Section titled “Budget.parent_budget_id?”
optionalparent_budget_id?:string|null
Description
Section titled “Description”ID of parent Budget.
Budget.period_type
Section titled “Budget.period_type”period_type:
"WEEKLY"|"MONTHLY"|"QUARTERLY"|"YEARLY"|"ONE_TIME"
Budget.spend_type
Section titled “Budget.spend_type”spend_type:
"BUDGET_PROVISIONED_CARDS_ONLY"|"NON_BUDGET_PROVISIONED_CARDS_ALLOWED"
Budget.start_date?
Section titled “Budget.start_date?”
optionalstart_date?:string|null
Format: date
Description
Section titled “Description”The UTC date when the Spend Limit should start counting.
Budget.templateId?
Section titled “Budget.templateId?”
optionaltemplateId?:string|null
BudgetBlueprint
Section titled “BudgetBlueprint”BudgetBlueprint:
object
Description
Section titled “Description”Blueprint for provisioning Spend Limits for a Budget Program.
BudgetBlueprint.description?
Section titled “BudgetBlueprint.description?”
optionaldescription?:string|null
Description
Section titled “Description”Description of what the Spend Limit is used for.
BudgetBlueprint.end_date?
Section titled “BudgetBlueprint.end_date?”
optionalend_date?:string|null
Format: date
Description
Section titled “Description”The UTC date when the Spend Limit should stop counting.
BudgetBlueprint.id
Section titled “BudgetBlueprint.id”id:
string
BudgetBlueprint.limit?
Section titled “BudgetBlueprint.limit?”
optionallimit?: {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
BudgetBlueprint.limit_type
Section titled “BudgetBlueprint.limit_type”limit_type:
"HARD"|"SOFT"
BudgetBlueprint.limit_visibility
Section titled “BudgetBlueprint.limit_visibility”limit_visibility:
"PRIVATE"|"SHARED"
BudgetBlueprint.name
Section titled “BudgetBlueprint.name”name:
string
Description
Section titled “Description”Name for the Spend Limit.
BudgetBlueprint.owner_user_ids
Section titled “BudgetBlueprint.owner_user_ids”owner_user_ids:
string[]
Description
Section titled “Description”User IDs of the owners of the Spend Limit.
BudgetBlueprint.parent_budget_id
Section titled “BudgetBlueprint.parent_budget_id”parent_budget_id:
string
Description
Section titled “Description”ID of parent Budget.
BudgetBlueprint.period_type
Section titled “BudgetBlueprint.period_type”period_type:
"WEEKLY"|"MONTHLY"|"QUARTERLY"|"YEARLY"|"ONE_TIME"
BudgetBlueprint.spend_type
Section titled “BudgetBlueprint.spend_type”spend_type:
"BUDGET_PROVISIONED_CARDS_ONLY"|"NON_BUDGET_PROVISIONED_CARDS_ALLOWED"
BudgetBlueprint.start_date?
Section titled “BudgetBlueprint.start_date?”
optionalstart_date?:string|null
Format: date
Description
Section titled “Description”The UTC date when the Spend Limit should start counting.
BudgetLimitVisibilityType
Section titled “BudgetLimitVisibilityType”BudgetLimitVisibilityType:
"PRIVATE"|"SHARED"
Description
Section titled “Description”Determines if Spend Limit members are allowed to view the Spend Limit’s limit.
BudgetPeriodBalance
Section titled “BudgetPeriodBalance”BudgetPeriodBalance:
object
Description
Section titled “Description”Current Spend Limit period balance.
BudgetPeriodBalance.balance?
Section titled “BudgetPeriodBalance.balance?”
optionalbalance?: {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
BudgetPeriodBalance.end_date?
Section titled “BudgetPeriodBalance.end_date?”
optionalend_date?:string|null
Format: date
BudgetPeriodBalance.start_date?
Section titled “BudgetPeriodBalance.start_date?”
optionalstart_date?:string|null
Format: date
BudgetProgram
Section titled “BudgetProgram”BudgetProgram:
object
Description
Section titled “Description”Budget Program used to create Spend Limits for eligible users.
BudgetProgram.budget_blueprints
Section titled “BudgetProgram.budget_blueprints”budget_blueprints:
object[]
BudgetProgram.budget_program_status
Section titled “BudgetProgram.budget_program_status”budget_program_status:
"BUDGET_PROGRAM_STATUS_ACTIVE"|"BUDGET_PROGRAM_STATUS_INACTIVE"|"BUDGET_PROGRAM_STATUS_DELETED"
BudgetProgram.created_at
Section titled “BudgetProgram.created_at”created_at:
string
Format: date
BudgetProgram.creator_user_id?
Section titled “BudgetProgram.creator_user_id?”
optionalcreator_user_id?:string|null
BudgetProgram.description?
Section titled “BudgetProgram.description?”
optionaldescription?:string|null
BudgetProgram.employee_filter?
Section titled “BudgetProgram.employee_filter?”
optionalemployee_filter?: {employment_status?:"EMPLOYMENT_STATUS_ACTIVE"|"EMPLOYMENT_STATUS_INACTIVE"|"EMPLOYMENT_STATUS_PENDING"|null;employment_type?:"EMPLOYMENT_TYPE_FULL_TIME"|"EMPLOYMENT_TYPE_PART_TIME"|"EMPLOYMENT_TYPE_CONTRACTOR"|"EMPLOYMENT_TYPE_INTERN"|"EMPLOYMENT_TYPE_FREELANCE"|null; } |null
BudgetProgram.existing_budget_ids?
Section titled “BudgetProgram.existing_budget_ids?”
optionalexisting_budget_ids?:string[] |null
Description
Section titled “Description”IDs for existing Spend Limits associated with this Budget Program.
BudgetProgram.id
Section titled “BudgetProgram.id”id:
string
BudgetProgram.name
Section titled “BudgetProgram.name”name:
string
BudgetProgram.updated_at
Section titled “BudgetProgram.updated_at”updated_at:
string
Format: date
BudgetProgramStatus
Section titled “BudgetProgramStatus”BudgetProgramStatus:
"BUDGET_PROGRAM_STATUS_ACTIVE"|"BUDGET_PROGRAM_STATUS_INACTIVE"|"BUDGET_PROGRAM_STATUS_DELETED"
BudgetStatus
Section titled “BudgetStatus”BudgetStatus:
"DELETED"|"APPROVED"|"EXPIRED"|"TERMINATED"
Description
Section titled “Description”Status of the Spend Limit e.g. APPROVED.
BudgetType
Section titled “BudgetType”BudgetType:
"BUDGET"|"SPEND_LIMIT"
Description
Section titled “Description”Whether this is a Budget or a Spend Limit for post-bifurcation entities.
CreateAuthorizationSettings
Section titled “CreateAuthorizationSettings”CreateAuthorizationSettings:
object
CreateAuthorizationSettings.authorization_type
Section titled “CreateAuthorizationSettings.authorization_type”authorization_type:
"HARD"|"SOFT"
CreateAuthorizationSettings.base_limit
Section titled “CreateAuthorizationSettings.base_limit”base_limit:
object
CreateAuthorizationSettings.base_limit.amount
Section titled “CreateAuthorizationSettings.base_limit.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”700CreateAuthorizationSettings.base_limit.currency
Section titled “CreateAuthorizationSettings.base_limit.currency”currency:
string|null
Description
Section titled “Description”The type of currency, in ISO 4217 format.
Default
Section titled “Default”USDExample
Section titled “Example”USDCreateAuthorizationSettings.limit_buffer_percentage?
Section titled “CreateAuthorizationSettings.limit_buffer_percentage?”
optionallimit_buffer_percentage?:number|null
Format: int32
Description
Section titled “Description”The percentage of flexible buffer on the limit as a 0-100 integer.
CreateAuthorizationSettings.rollover_refresh_rate
Section titled “CreateAuthorizationSettings.rollover_refresh_rate”rollover_refresh_rate:
"OFF"|"NEVER"|"PER_MONTH"|"PER_QUARTER"|"PER_YEAR"
CreateBudgetBlueprintRequest
Section titled “CreateBudgetBlueprintRequest”CreateBudgetBlueprintRequest:
object
Description
Section titled “Description”Blueprint for provisioning Spend Limits for a Budget Program.
CreateBudgetBlueprintRequest.description
Section titled “CreateBudgetBlueprintRequest.description”description:
string
Description
Section titled “Description”Description of what the Spend Limit is used for.
CreateBudgetBlueprintRequest.end_date?
Section titled “CreateBudgetBlueprintRequest.end_date?”
optionalend_date?:string|null
Format: date
Description
Section titled “Description”The UTC date when the Spend Limit should stop counting.
CreateBudgetBlueprintRequest.limit
Section titled “CreateBudgetBlueprintRequest.limit”limit:
object
CreateBudgetBlueprintRequest.limit.amount
Section titled “CreateBudgetBlueprintRequest.limit.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”700CreateBudgetBlueprintRequest.limit.currency
Section titled “CreateBudgetBlueprintRequest.limit.currency”currency:
string|null
Description
Section titled “Description”The type of currency, in ISO 4217 format.
Default
Section titled “Default”USDExample
Section titled “Example”USDCreateBudgetBlueprintRequest.limit_type
Section titled “CreateBudgetBlueprintRequest.limit_type”limit_type:
"HARD"|"SOFT"
CreateBudgetBlueprintRequest.limit_visibility
Section titled “CreateBudgetBlueprintRequest.limit_visibility”limit_visibility:
"PRIVATE"|"SHARED"
CreateBudgetBlueprintRequest.name
Section titled “CreateBudgetBlueprintRequest.name”name:
string
Description
Section titled “Description”Name for the Spend Limit.
CreateBudgetBlueprintRequest.owner_user_ids?
Section titled “CreateBudgetBlueprintRequest.owner_user_ids?”
optionalowner_user_ids?:string[] |null
Description
Section titled “Description”User IDs of the owners of the Spend Limit.
CreateBudgetBlueprintRequest.parent_budget_id
Section titled “CreateBudgetBlueprintRequest.parent_budget_id”parent_budget_id:
string
Description
Section titled “Description”ID of parent Budget.
CreateBudgetBlueprintRequest.period_type
Section titled “CreateBudgetBlueprintRequest.period_type”period_type:
"WEEKLY"|"MONTHLY"|"QUARTERLY"|"YEARLY"|"ONE_TIME"
CreateBudgetBlueprintRequest.spend_type
Section titled “CreateBudgetBlueprintRequest.spend_type”spend_type:
"BUDGET_PROVISIONED_CARDS_ONLY"|"NON_BUDGET_PROVISIONED_CARDS_ALLOWED"
CreateBudgetBlueprintRequest.start_date?
Section titled “CreateBudgetBlueprintRequest.start_date?”
optionalstart_date?:string|null
Format: date
Description
Section titled “Description”The UTC date when the Spend Limit should start counting.
CreateBudgetProgramRequest
Section titled “CreateBudgetProgramRequest”CreateBudgetProgramRequest:
object
Description
Section titled “Description”Budget Program used to create Spend Limits for eligible users.
CreateBudgetProgramRequest.budget_blueprints
Section titled “CreateBudgetProgramRequest.budget_blueprints”budget_blueprints:
object[]
CreateBudgetProgramRequest.description?
Section titled “CreateBudgetProgramRequest.description?”
optionaldescription?:string|null
CreateBudgetProgramRequest.employee_filter?
Section titled “CreateBudgetProgramRequest.employee_filter?”
optionalemployee_filter?: {employment_status?:"EMPLOYMENT_STATUS_ACTIVE"|"EMPLOYMENT_STATUS_INACTIVE"|"EMPLOYMENT_STATUS_PENDING"|null;employment_type?:"EMPLOYMENT_TYPE_FULL_TIME"|"EMPLOYMENT_TYPE_PART_TIME"|"EMPLOYMENT_TYPE_CONTRACTOR"|"EMPLOYMENT_TYPE_INTERN"|"EMPLOYMENT_TYPE_FREELANCE"|null; } |null
CreateBudgetProgramRequest.existing_budget_ids?
Section titled “CreateBudgetProgramRequest.existing_budget_ids?”
optionalexisting_budget_ids?:string[] |null
Description
Section titled “Description”IDs for existing Spend Limits associated with this Budget Program.
CreateBudgetProgramRequest.name
Section titled “CreateBudgetProgramRequest.name”name:
string
CreateBudgetRequest
Section titled “CreateBudgetRequest”CreateBudgetRequest:
object
CreateBudgetRequest.description
Section titled “CreateBudgetRequest.description”description:
string
Description
Section titled “Description”Description of what the Spend Limit is used for.
CreateBudgetRequest.end_date?
Section titled “CreateBudgetRequest.end_date?”
optionalend_date?:string|null
Format: date
Description
Section titled “Description”The UTC date when the Spend Limit should stop counting.
CreateBudgetRequest.entity_id?
Section titled “CreateBudgetRequest.entity_id?”
optionalentity_id?:string|null
CreateBudgetRequest.limit
Section titled “CreateBudgetRequest.limit”limit:
object
CreateBudgetRequest.limit.amount
Section titled “CreateBudgetRequest.limit.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”700CreateBudgetRequest.limit.currency
Section titled “CreateBudgetRequest.limit.currency”currency:
string|null
Description
Section titled “Description”The type of currency, in ISO 4217 format.
Default
Section titled “Default”USDExample
Section titled “Example”USDCreateBudgetRequest.limit_type
Section titled “CreateBudgetRequest.limit_type”limit_type:
"HARD"|"SOFT"
CreateBudgetRequest.limit_visibility
Section titled “CreateBudgetRequest.limit_visibility”limit_visibility:
"PRIVATE"|"SHARED"
CreateBudgetRequest.member_user_ids?
Section titled “CreateBudgetRequest.member_user_ids?”
optionalmember_user_ids?:string[] |null
Description
Section titled “Description”User IDs of the members of the Spend Limit.
CreateBudgetRequest.name
Section titled “CreateBudgetRequest.name”name:
string
Description
Section titled “Description”Name for the Spend Limit.
CreateBudgetRequest.owner_user_ids?
Section titled “CreateBudgetRequest.owner_user_ids?”
optionalowner_user_ids?:string[] |null
Description
Section titled “Description”User IDs of the owners of the Spend Limit.
CreateBudgetRequest.parent_budget_id
Section titled “CreateBudgetRequest.parent_budget_id”parent_budget_id:
string
Description
Section titled “Description”ID of parent Budget.
CreateBudgetRequest.period_type
Section titled “CreateBudgetRequest.period_type”period_type:
"WEEKLY"|"MONTHLY"|"QUARTERLY"|"YEARLY"|"ONE_TIME"
CreateBudgetRequest.policy_id?
Section titled “CreateBudgetRequest.policy_id?”
optionalpolicy_id?:string|null
CreateBudgetRequest.spend_type
Section titled “CreateBudgetRequest.spend_type”spend_type:
"BUDGET_PROVISIONED_CARDS_ONLY"|"NON_BUDGET_PROVISIONED_CARDS_ALLOWED"
CreateBudgetRequest.start_date?
Section titled “CreateBudgetRequest.start_date?”
optionalstart_date?:string|null
Format: date
Description
Section titled “Description”The UTC date when the Spend Limit should start counting.
CreateSpendBudgetRequest
Section titled “CreateSpendBudgetRequest”CreateSpendBudgetRequest:
object
CreateSpendBudgetRequest.amount
Section titled “CreateSpendBudgetRequest.amount”amount:
object
CreateSpendBudgetRequest.amount.amount
Section titled “CreateSpendBudgetRequest.amount.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”700CreateSpendBudgetRequest.amount.currency
Section titled “CreateSpendBudgetRequest.amount.currency”currency:
string|null
Description
Section titled “Description”The type of currency, in ISO 4217 format.
Default
Section titled “Default”USDExample
Section titled “Example”USDCreateSpendBudgetRequest.description
Section titled “CreateSpendBudgetRequest.description”description:
string
Description
Section titled “Description”Description of what the Budget is used for.
CreateSpendBudgetRequest.end_date?
Section titled “CreateSpendBudgetRequest.end_date?”
optionalend_date?:string|null
Format: date
Description
Section titled “Description”The date when the Budget should stop counting.
CreateSpendBudgetRequest.limit_type?
Section titled “CreateSpendBudgetRequest.limit_type?”
optionallimit_type?:"HARD"|"SOFT"|null
CreateSpendBudgetRequest.name
Section titled “CreateSpendBudgetRequest.name”name:
string
Description
Section titled “Description”Name for the Budget.
CreateSpendBudgetRequest.owner_user_ids?
Section titled “CreateSpendBudgetRequest.owner_user_ids?”
optionalowner_user_ids?:string[] |null
Description
Section titled “Description”User IDs of the owners of the Budget.
CreateSpendBudgetRequest.parent_budget_id
Section titled “CreateSpendBudgetRequest.parent_budget_id”parent_budget_id:
string
Description
Section titled “Description”ID of parent Budget.
CreateSpendBudgetRequest.period_recurrence_type
Section titled “CreateSpendBudgetRequest.period_recurrence_type”period_recurrence_type:
"WEEKLY"|"MONTHLY"|"QUARTERLY"|"YEARLY"|"ONE_TIME"
CreateSpendBudgetRequest.start_date?
Section titled “CreateSpendBudgetRequest.start_date?”
optionalstart_date?:string|null
Format: date
Description
Section titled “Description”The date when the Budget should start counting.
CreateSpendLimitRequest
Section titled “CreateSpendLimitRequest”CreateSpendLimitRequest:
object
CreateSpendLimitRequest.authorization_settings
Section titled “CreateSpendLimitRequest.authorization_settings”authorization_settings:
object
CreateSpendLimitRequest.authorization_settings.authorization_type
Section titled “CreateSpendLimitRequest.authorization_settings.authorization_type”authorization_type:
"HARD"|"SOFT"
CreateSpendLimitRequest.authorization_settings.base_limit
Section titled “CreateSpendLimitRequest.authorization_settings.base_limit”base_limit:
object
CreateSpendLimitRequest.authorization_settings.base_limit.amount
Section titled “CreateSpendLimitRequest.authorization_settings.base_limit.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”700CreateSpendLimitRequest.authorization_settings.base_limit.currency
Section titled “CreateSpendLimitRequest.authorization_settings.base_limit.currency”currency:
string|null
Description
Section titled “Description”The type of currency, in ISO 4217 format.
Default
Section titled “Default”USDExample
Section titled “Example”USDCreateSpendLimitRequest.authorization_settings.limit_buffer_percentage?
Section titled “CreateSpendLimitRequest.authorization_settings.limit_buffer_percentage?”
optionallimit_buffer_percentage?:number|null
Format: int32
Description
Section titled “Description”The percentage of flexible buffer on the limit as a 0-100 integer.
CreateSpendLimitRequest.authorization_settings.rollover_refresh_rate
Section titled “CreateSpendLimitRequest.authorization_settings.rollover_refresh_rate”rollover_refresh_rate:
"OFF"|"NEVER"|"PER_MONTH"|"PER_QUARTER"|"PER_YEAR"
CreateSpendLimitRequest.authorization_visibility
Section titled “CreateSpendLimitRequest.authorization_visibility”authorization_visibility:
"PUBLIC"|"PRIVATE"
CreateSpendLimitRequest.auto_create_limit_cards_setting
Section titled “CreateSpendLimitRequest.auto_create_limit_cards_setting”auto_create_limit_cards_setting:
"DISABLED"|"ALL_MEMBERS"
CreateSpendLimitRequest.auto_transfer_cards_setting
Section titled “CreateSpendLimitRequest.auto_transfer_cards_setting”auto_transfer_cards_setting:
"DISABLED"|"ENABLED"
CreateSpendLimitRequest.department_id?
Section titled “CreateSpendLimitRequest.department_id?”
optionaldepartment_id?:string|null
Description
Section titled “Description”The department ID to which Spend Limit expenses will be attributed.
CreateSpendLimitRequest.description?
Section titled “CreateSpendLimitRequest.description?”
optionaldescription?:string|null
Description
Section titled “Description”Description of what the Spend Limit is used for.
CreateSpendLimitRequest.end_date?
Section titled “CreateSpendLimitRequest.end_date?”
optionalend_date?:string|null
Format: date
Description
Section titled “Description”The date when the Spend Limit should expire.
CreateSpendLimitRequest.expense_policy_id
Section titled “CreateSpendLimitRequest.expense_policy_id”expense_policy_id:
string
Description
Section titled “Description”The ID of the expense policy corresponding to this Spend Limit.
CreateSpendLimitRequest.expense_visibility
Section titled “CreateSpendLimitRequest.expense_visibility”expense_visibility:
"PRIVATE"|"SHARED"
CreateSpendLimitRequest.legal_entity_id?
Section titled “CreateSpendLimitRequest.legal_entity_id?”
optionallegal_entity_id?:string|null
Description
Section titled “Description”The legal entity ID to which Spend Limit expenses will be attributed. If not set, expenses will be attributed to the spending user’s entity.
CreateSpendLimitRequest.limit_approval_policy_id?
Section titled “CreateSpendLimitRequest.limit_approval_policy_id?”
optionallimit_approval_policy_id?:string|null
Description
Section titled “Description”The ID of the policy for limit increase approval requests. Meant to replace limit_increase_request_policy_id.
CreateSpendLimitRequest.limit_increase_request_policy_id?
Section titled “CreateSpendLimitRequest.limit_increase_request_policy_id?”
optionallimit_increase_request_policy_id?:string|null
Description
Section titled “Description”The ID of the policy for limit increase requests for this Spend Limit.
CreateSpendLimitRequest.limit_increase_setting
Section titled “CreateSpendLimitRequest.limit_increase_setting”limit_increase_setting:
"DISABLED"|"ENABLED"
CreateSpendLimitRequest.member_user_ids?
Section titled “CreateSpendLimitRequest.member_user_ids?”
optionalmember_user_ids?:string[] |null
Description
Section titled “Description”User IDs of the members of the Spend Limit.
CreateSpendLimitRequest.name
Section titled “CreateSpendLimitRequest.name”name:
string
Description
Section titled “Description”Name for the Spend Limit.
CreateSpendLimitRequest.owner_user_ids?
Section titled “CreateSpendLimitRequest.owner_user_ids?”
optionalowner_user_ids?:string[] |null
Description
Section titled “Description”User IDs of the owners of the Spend Limit.
CreateSpendLimitRequest.parent_budget_id?
Section titled “CreateSpendLimitRequest.parent_budget_id?”
optionalparent_budget_id?:string|null
Description
Section titled “Description”ID of parent Budget.
CreateSpendLimitRequest.period_recurrence_type
Section titled “CreateSpendLimitRequest.period_recurrence_type”period_recurrence_type:
"PER_MONTH"|"PER_QUARTER"|"PER_YEAR"|"ONE_TIME"|"PER_WEEK"
CreateSpendLimitRequest.spend_type
Section titled “CreateSpendLimitRequest.spend_type”spend_type:
"BUDGET_PROVISIONED_CARDS_ONLY"|"NON_BUDGET_PROVISIONED_CARDS_ALLOWED"
CreateSpendLimitRequest.start_date?
Section titled “CreateSpendLimitRequest.start_date?”
optionalstart_date?:string|null
Format: date
Description
Section titled “Description”The date when the Spend Limit should start counting.
CreateSpendLimitRequest.transaction_limit?
Section titled “CreateSpendLimitRequest.transaction_limit?”
optionaltransaction_limit?: {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
EmployeeFilter
Section titled “EmployeeFilter”EmployeeFilter:
object
Description
Section titled “Description”A filter used to determine if a user adheres to a Budget Program.
EmployeeFilter.employment_status?
Section titled “EmployeeFilter.employment_status?”
optionalemployment_status?:"EMPLOYMENT_STATUS_ACTIVE"|"EMPLOYMENT_STATUS_INACTIVE"|"EMPLOYMENT_STATUS_PENDING"|null
EmployeeFilter.employment_type?
Section titled “EmployeeFilter.employment_type?”
optionalemployment_type?:"EMPLOYMENT_TYPE_FULL_TIME"|"EMPLOYMENT_TYPE_PART_TIME"|"EMPLOYMENT_TYPE_CONTRACTOR"|"EMPLOYMENT_TYPE_INTERN"|"EMPLOYMENT_TYPE_FREELANCE"|null
EmploymentStatus
Section titled “EmploymentStatus”EmploymentStatus:
"EMPLOYMENT_STATUS_ACTIVE"|"EMPLOYMENT_STATUS_INACTIVE"|"EMPLOYMENT_STATUS_PENDING"
Description
Section titled “Description”A filter used to determine if a user adheres to a Budget Program.
EmploymentType
Section titled “EmploymentType”EmploymentType:
"EMPLOYMENT_TYPE_FULL_TIME"|"EMPLOYMENT_TYPE_PART_TIME"|"EMPLOYMENT_TYPE_CONTRACTOR"|"EMPLOYMENT_TYPE_INTERN"|"EMPLOYMENT_TYPE_FREELANCE"
Description
Section titled “Description”What kind of employment the employee has.
ExpenseVisibility
Section titled “ExpenseVisibility”ExpenseVisibility:
"PRIVATE"|"SHARED"
Description
Section titled “Description”Whether or not expense related to this Spend Limit should be viewable to all members.
LimitIncreaseSetting
Section titled “LimitIncreaseSetting”LimitIncreaseSetting:
"DISABLED"|"ENABLED"
Description
Section titled “Description”Whether or not members can request limit increases.
LimitType
Section titled “LimitType”LimitType:
"HARD"|"SOFT"
Description
Section titled “Description”Whether the Spend Limit’s limit blocks spend.
LimitType_1
Section titled “LimitType_1”LimitType_1:
"HARD"|"SOFT"
Description
Section titled “Description”Whether the Budget amount blocks spend. HARD is rejected; use /v2/spend_limits for hard-auth limits.
LimitType_3
Section titled “LimitType_3”LimitType_3:
"HARD"|"SOFT"
Description
Section titled “Description”Whether the Budget amount blocks spend. HARD is rejected; use /v2/spend_limits for hard-auth limits.
LimitType_4
Section titled “LimitType_4”LimitType_4:
"HARD"|"SOFT"
Description
Section titled “Description”Whether the Budget amount blocks spend. HARD is rejected; use /v2/spend_limits for hard-auth limits.
MerchantCategory
Section titled “MerchantCategory”MerchantCategory:
"ADVERTISING_MARKETING"|"GROCERY"|"TELEPHONY"|"OFFICE_SUPPLIES"|"PRIVATE_AIR_TRAVEL"|"CLOTHING"|"CAR_RENTAL"|"VEHICLE_EXPENSES"|"RESTAURANTS"|"GAMBLING"|"FLOWERS"|"ELECTRONICS"|"LEGAL_SERVICES"|"UTILITIES"|"FURNITURE"|"BARS_NIGHTLIFE"|"LAUNDRY"|"EVENT_EXPENSES"|"SHIPPING"|"OTHER_TRAVEL_EXPENSES"|"CHARITY"|"SOFTWARE"|"LODGING"|"FACILITIES_EXPENSES"|"SERVERS"|"CONFERENCES"|"FOOD_DELIVERY"|"RENT"|"AIRLINE_EXPENSES"|"OTHER_BUSINESS_EXPENSES"|"BANK_FINANCIAL_FEES"|"BOOKS_NEWSPAPERS"|"CONSULTANT_CONTRACTOR"|"CORPORATE_INSURANCE"|"DIGITAL_GOODS"|"LICENSES_TAXES"|"GAS_FUEL"|"GENERAL_MERCHANDISE"|"MEDICAL"|"MEMBERSHIPS_CLUBS"|"PARKING_EXPENSES"|"POLITICAL_DONATIONS"|"PUBLIC_TRANSPORTATION"|"RECURRING_SOFTWARE_SAAS"|"RIDESHARE_TAXI"|"TOLL_BRIDGE_FEES"|"TRAINING_EDUCATION"|"TRAVEL"
MerchantCategoryControls
Section titled “MerchantCategoryControls”MerchantCategoryControls:
object
MerchantCategoryControls.allowed_merchant_categories?
Section titled “MerchantCategoryControls.allowed_merchant_categories?”
optionalallowed_merchant_categories?: ("ADVERTISING_MARKETING"|"GROCERY"|"TELEPHONY"|"OFFICE_SUPPLIES"|"PRIVATE_AIR_TRAVEL"|"CLOTHING"|"CAR_RENTAL"|"VEHICLE_EXPENSES"|"RESTAURANTS"|"GAMBLING"|"FLOWERS"|"ELECTRONICS"|"LEGAL_SERVICES"|"UTILITIES"|"FURNITURE"|"BARS_NIGHTLIFE"|"LAUNDRY"|"EVENT_EXPENSES"|"SHIPPING"|"OTHER_TRAVEL_EXPENSES"|"CHARITY"|"SOFTWARE"|"LODGING"|"FACILITIES_EXPENSES"|"SERVERS"|"CONFERENCES"|"FOOD_DELIVERY"|"RENT"|"AIRLINE_EXPENSES"|"OTHER_BUSINESS_EXPENSES"|"BANK_FINANCIAL_FEES"|"BOOKS_NEWSPAPERS"|"CONSULTANT_CONTRACTOR"|"CORPORATE_INSURANCE"|"DIGITAL_GOODS"|"LICENSES_TAXES"|"GAS_FUEL"|"GENERAL_MERCHANDISE"|"MEDICAL"|"MEMBERSHIPS_CLUBS"|"PARKING_EXPENSES"|"POLITICAL_DONATIONS"|"PUBLIC_TRANSPORTATION"|"RECURRING_SOFTWARE_SAAS"|"RIDESHARE_TAXI"|"TOLL_BRIDGE_FEES"|"TRAINING_EDUCATION"|"TRAVEL")[] |null
MerchantCategoryControls.blocked_merchant_categories?
Section titled “MerchantCategoryControls.blocked_merchant_categories?”
optionalblocked_merchant_categories?: ("ADVERTISING_MARKETING"|"GROCERY"|"TELEPHONY"|"OFFICE_SUPPLIES"|"PRIVATE_AIR_TRAVEL"|"CLOTHING"|"CAR_RENTAL"|"VEHICLE_EXPENSES"|"RESTAURANTS"|"GAMBLING"|"FLOWERS"|"ELECTRONICS"|"LEGAL_SERVICES"|"UTILITIES"|"FURNITURE"|"BARS_NIGHTLIFE"|"LAUNDRY"|"EVENT_EXPENSES"|"SHIPPING"|"OTHER_TRAVEL_EXPENSES"|"CHARITY"|"SOFTWARE"|"LODGING"|"FACILITIES_EXPENSES"|"SERVERS"|"CONFERENCES"|"FOOD_DELIVERY"|"RENT"|"AIRLINE_EXPENSES"|"OTHER_BUSINESS_EXPENSES"|"BANK_FINANCIAL_FEES"|"BOOKS_NEWSPAPERS"|"CONSULTANT_CONTRACTOR"|"CORPORATE_INSURANCE"|"DIGITAL_GOODS"|"LICENSES_TAXES"|"GAS_FUEL"|"GENERAL_MERCHANDISE"|"MEDICAL"|"MEMBERSHIPS_CLUBS"|"PARKING_EXPENSES"|"POLITICAL_DONATIONS"|"PUBLIC_TRANSPORTATION"|"RECURRING_SOFTWARE_SAAS"|"RIDESHARE_TAXI"|"TOLL_BRIDGE_FEES"|"TRAINING_EDUCATION"|"TRAVEL")[] |null
Money:
object
Description
Section titled “Description”Money fields can be signed or unsigned. Fields are signed (an unsigned value will be interpreted as positive). The amount of money will be represented in the smallest denomination of the currency indicated. For example, USD 7.00 will be represented in cents with an amount of 700.
Money.amount
Section titled “Money.amount”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”700Money.currency
Section titled “Money.currency”currency:
string|null
Description
Section titled “Description”The type of currency, in ISO 4217 format.
Default
Section titled “Default”USDExample
Section titled “Example”USDPage_Budget_
Section titled “Page_Budget_”Page_Budget_:
object
Page_Budget_.items
Section titled “Page_Budget_.items”items:
object[]
Page_Budget_.next_cursor?
Section titled “Page_Budget_.next_cursor?”
optionalnext_cursor?:string|null
Page_BudgetProgram_
Section titled “Page_BudgetProgram_”Page_BudgetProgram_:
object
Page_BudgetProgram_.items
Section titled “Page_BudgetProgram_.items”items:
object[]
Page_BudgetProgram_.next_cursor?
Section titled “Page_BudgetProgram_.next_cursor?”
optionalnext_cursor?:string|null
Page_SpendBudget_
Section titled “Page_SpendBudget_”Page_SpendBudget_:
object
Page_SpendBudget_.items
Section titled “Page_SpendBudget_.items”items:
object[]
Page_SpendBudget_.next_cursor?
Section titled “Page_SpendBudget_.next_cursor?”
optionalnext_cursor?:string|null
Page_SpendLimit_
Section titled “Page_SpendLimit_”Page_SpendLimit_:
object
Page_SpendLimit_.items
Section titled “Page_SpendLimit_.items”items:
object[]
Page_SpendLimit_.next_cursor?
Section titled “Page_SpendLimit_.next_cursor?”
optionalnext_cursor?:string|null
PeriodRecurrenceType
Section titled “PeriodRecurrenceType”PeriodRecurrenceType:
"WEEKLY"|"MONTHLY"|"QUARTERLY"|"YEARLY"|"ONE_TIME"
Description
Section titled “Description”Period type of the Budget e.g. MONTHLY.
PeriodType
Section titled “PeriodType”PeriodType:
"WEEKLY"|"MONTHLY"|"QUARTERLY"|"YEARLY"|"ONE_TIME"
Description
Section titled “Description”Period type of the Spend Limit e.g. MONTHLY.
RolloverRefreshRate
Section titled “RolloverRefreshRate”RolloverRefreshRate:
"OFF"|"NEVER"|"PER_MONTH"|"PER_QUARTER"|"PER_YEAR"
Description
Section titled “Description”The rollover refresh rate for this spend limit (the recurrence by which all rolled over unused funds within the cycle should no longer roll over to the next period).
SpendBudget
Section titled “SpendBudget”SpendBudget:
object
SpendBudget.account_id
Section titled “SpendBudget.account_id”account_id:
string
Description
Section titled “Description”The Brex account this Budget belongs to.
SpendBudget.amount?
Section titled “SpendBudget.amount?”
optionalamount?: {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
SpendBudget.budget_id
Section titled “SpendBudget.budget_id”budget_id:
string
Description
Section titled “Description”Unique ID for the Budget.
SpendBudget.description?
Section titled “SpendBudget.description?”
optionaldescription?:string|null
Description
Section titled “Description”Description of what the Budget is used for.
SpendBudget.end_date?
Section titled “SpendBudget.end_date?”
optionalend_date?:string|null
Format: date
Description
Section titled “Description”The date when the Budget should stop counting.
SpendBudget.limit_type?
Section titled “SpendBudget.limit_type?”
optionallimit_type?:"HARD"|"SOFT"|null
SpendBudget.name
Section titled “SpendBudget.name”name:
string
Description
Section titled “Description”Name for the Budget.
SpendBudget.owner_user_ids
Section titled “SpendBudget.owner_user_ids”owner_user_ids:
string[]
Description
Section titled “Description”User IDs of the owners of the Budget.
SpendBudget.parent_budget_id?
Section titled “SpendBudget.parent_budget_id?”
optionalparent_budget_id?:string|null
Description
Section titled “Description”ID of parent Budget.
SpendBudget.period_recurrence_type
Section titled “SpendBudget.period_recurrence_type”period_recurrence_type:
"WEEKLY"|"MONTHLY"|"QUARTERLY"|"YEARLY"|"ONE_TIME"
SpendBudget.spend_budget_status
Section titled “SpendBudget.spend_budget_status”spend_budget_status:
"ACTIVE"|"ARCHIVED"|"DELETED"|"EXPIRED"
SpendBudget.start_date?
Section titled “SpendBudget.start_date?”
optionalstart_date?:string|null
Format: date
Description
Section titled “Description”The date when the Budget should start counting.
SpendBudgetStatus
Section titled “SpendBudgetStatus”SpendBudgetStatus:
"ACTIVE"|"ARCHIVED"|"DELETED"|"EXPIRED"
Description
Section titled “Description”Status of the Budget e.g. ACTIVE.
SpendLimit
Section titled “SpendLimit”SpendLimit:
object
SpendLimit.account_id
Section titled “SpendLimit.account_id”account_id:
string
Description
Section titled “Description”The Brex account this Spend Limit belongs to.
SpendLimit.authorization_settings?
Section titled “SpendLimit.authorization_settings?”
optionalauthorization_settings?: {authorization_type:"HARD"|"SOFT";base_limit: {amount:number;currency:string|null; };limit_buffer_percentage?:number|null;limit_with_increases: {amount:number;currency:string|null; };rollover_refresh_rate:"OFF"|"NEVER"|"PER_MONTH"|"PER_QUARTER"|"PER_YEAR"; } |null
Union Members
Section titled “Union Members”Type Literal
Section titled “Type Literal”{ authorization_type: "HARD" | "SOFT"; base_limit: { amount: number; currency: string | null; }; limit_buffer_percentage?: number | null; limit_with_increases: { amount: number; currency: string | null; }; rollover_refresh_rate: "OFF" | "NEVER" | "PER_MONTH" | "PER_QUARTER" | "PER_YEAR"; }
authorization_type
Section titled “authorization_type”authorization_type:
"HARD"|"SOFT"
base_limit
Section titled “base_limit”base_limit:
object
base_limit.amount
Section titled “base_limit.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”700base_limit.currency
Section titled “base_limit.currency”currency:
string|null
Description
Section titled “Description”The type of currency, in ISO 4217 format.
Default
Section titled “Default”USDExample
Section titled “Example”USDlimit_buffer_percentage?
Section titled “limit_buffer_percentage?”
optionallimit_buffer_percentage?:number|null
Format: int32
Description
Section titled “Description”The percentage of flexible buffer on the limit as a 0-100 integer.
limit_with_increases
Section titled “limit_with_increases”limit_with_increases:
object
limit_with_increases.amount
Section titled “limit_with_increases.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”700limit_with_increases.currency
Section titled “limit_with_increases.currency”currency:
string|null
Description
Section titled “Description”The type of currency, in ISO 4217 format.
Default
Section titled “Default”USDExample
Section titled “Example”USDrollover_refresh_rate
Section titled “rollover_refresh_rate”rollover_refresh_rate:
"OFF"|"NEVER"|"PER_MONTH"|"PER_QUARTER"|"PER_YEAR"
null
SpendLimit.authorization_visibility
Section titled “SpendLimit.authorization_visibility”authorization_visibility:
"PUBLIC"|"PRIVATE"
SpendLimit.auto_create_limit_cards_setting
Section titled “SpendLimit.auto_create_limit_cards_setting”auto_create_limit_cards_setting:
"DISABLED"|"ALL_MEMBERS"
SpendLimit.auto_transfer_cards_setting
Section titled “SpendLimit.auto_transfer_cards_setting”auto_transfer_cards_setting:
"DISABLED"|"ENABLED"
SpendLimit.current_period_balance?
Section titled “SpendLimit.current_period_balance?”
optionalcurrent_period_balance?: {amount_spent?: {amount:number;currency:string|null; } |null;end_date?:string|null;end_time?:string|null;rollover_amount?: {amount:number;currency:string|null; } |null;start_date?:string|null;start_time?:string|null; } |null
Union Members
Section titled “Union Members”Type Literal
Section titled “Type Literal”{ amount_spent?: { amount: number; currency: string | null; } | null; end_date?: string | null; end_time?: string | null; rollover_amount?: { amount: number; currency: string | null; } | null; start_date?: string | null; start_time?: string | null; }
amount_spent?
Section titled “amount_spent?”
optionalamount_spent?: {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
end_date?
Section titled “end_date?”
optionalend_date?:string|null
Format: date
end_time?
Section titled “end_time?”
optionalend_time?:string|null
Format: date-time
rollover_amount?
Section titled “rollover_amount?”
optionalrollover_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
start_date?
Section titled “start_date?”
optionalstart_date?:string|null
Format: date
start_time?
Section titled “start_time?”
optionalstart_time?:string|null
Format: date-time
null
SpendLimit.department_id?
Section titled “SpendLimit.department_id?”
optionaldepartment_id?:string|null
Description
Section titled “Description”The department ID to which Spend Limit expenses will be attributed.
SpendLimit.description?
Section titled “SpendLimit.description?”
optionaldescription?:string|null
Description
Section titled “Description”Description of what the Spend Limit is used for.
SpendLimit.end_date?
Section titled “SpendLimit.end_date?”
optionalend_date?:string|null
Format: date
Description
Section titled “Description”The date when the Spend Limit should expire.
SpendLimit.end_time_utc?
Section titled “SpendLimit.end_time_utc?”
optionalend_time_utc?:string|null
Format: date-time
Description
Section titled “Description”The UTC time when the Spend Limit should expire.
SpendLimit.expense_policy_id
Section titled “SpendLimit.expense_policy_id”expense_policy_id:
string
Description
Section titled “Description”The ID of the expense policy corresponding to this Spend Limit.
SpendLimit.expense_visibility
Section titled “SpendLimit.expense_visibility”expense_visibility:
"PRIVATE"|"SHARED"
SpendLimit.id
Section titled “SpendLimit.id”id:
string
Description
Section titled “Description”Unique ID for the Spend Limit.
SpendLimit.legal_entity_id?
Section titled “SpendLimit.legal_entity_id?”
optionallegal_entity_id?:string|null
Description
Section titled “Description”The legal entity ID to which Spend Limit expenses will be attributed. If not set, expenses will be attributed to the spending user’s entity.
SpendLimit.limit_approval_policy_id?
Section titled “SpendLimit.limit_approval_policy_id?”
optionallimit_approval_policy_id?:string|null
Description
Section titled “Description”The ID of the policy for limit increase approval requests. Meant to replace limit_increase_request_policy_id.
SpendLimit.limit_increase_request_policy_id?
Section titled “SpendLimit.limit_increase_request_policy_id?”
optionallimit_increase_request_policy_id?:string|null
Description
Section titled “Description”The ID of the policy for limit increase requests for this Spend Limit.
SpendLimit.limit_increase_setting
Section titled “SpendLimit.limit_increase_setting”limit_increase_setting:
"DISABLED"|"ENABLED"
SpendLimit.member_user_ids
Section titled “SpendLimit.member_user_ids”member_user_ids:
string[]
Description
Section titled “Description”User IDs of the members of the Spend Limit.
SpendLimit.merchant_category_controls?
Section titled “SpendLimit.merchant_category_controls?”
optionalmerchant_category_controls?: {allowed_merchant_categories?: ("ADVERTISING_MARKETING"|"GROCERY"|"TELEPHONY"|"OFFICE_SUPPLIES"|"PRIVATE_AIR_TRAVEL"|"CLOTHING"|"CAR_RENTAL"|"VEHICLE_EXPENSES"|"RESTAURANTS"|"GAMBLING"|"FLOWERS"|"ELECTRONICS"|"LEGAL_SERVICES"|"UTILITIES"|"FURNITURE"|"BARS_NIGHTLIFE"|"LAUNDRY"|"EVENT_EXPENSES"|"SHIPPING"|"OTHER_TRAVEL_EXPENSES"|"CHARITY"|"SOFTWARE"|"LODGING"|"FACILITIES_EXPENSES"|"SERVERS"|"CONFERENCES"|"FOOD_DELIVERY"|"RENT"|"AIRLINE_EXPENSES"|"OTHER_BUSINESS_EXPENSES"|"BANK_FINANCIAL_FEES"|"BOOKS_NEWSPAPERS"|"CONSULTANT_CONTRACTOR"|"CORPORATE_INSURANCE"|"DIGITAL_GOODS"|"LICENSES_TAXES"|"GAS_FUEL"|"GENERAL_MERCHANDISE"|"MEDICAL"|"MEMBERSHIPS_CLUBS"|"PARKING_EXPENSES"|"POLITICAL_DONATIONS"|"PUBLIC_TRANSPORTATION"|"RECURRING_SOFTWARE_SAAS"|"RIDESHARE_TAXI"|"TOLL_BRIDGE_FEES"|"TRAINING_EDUCATION"|"TRAVEL")[] |null;blocked_merchant_categories?: ("ADVERTISING_MARKETING"|"GROCERY"|"TELEPHONY"|"OFFICE_SUPPLIES"|"PRIVATE_AIR_TRAVEL"|"CLOTHING"|"CAR_RENTAL"|"VEHICLE_EXPENSES"|"RESTAURANTS"|"GAMBLING"|"FLOWERS"|"ELECTRONICS"|"LEGAL_SERVICES"|"UTILITIES"|"FURNITURE"|"BARS_NIGHTLIFE"|"LAUNDRY"|"EVENT_EXPENSES"|"SHIPPING"|"OTHER_TRAVEL_EXPENSES"|"CHARITY"|"SOFTWARE"|"LODGING"|"FACILITIES_EXPENSES"|"SERVERS"|"CONFERENCES"|"FOOD_DELIVERY"|"RENT"|"AIRLINE_EXPENSES"|"OTHER_BUSINESS_EXPENSES"|"BANK_FINANCIAL_FEES"|"BOOKS_NEWSPAPERS"|"CONSULTANT_CONTRACTOR"|"CORPORATE_INSURANCE"|"DIGITAL_GOODS"|"LICENSES_TAXES"|"GAS_FUEL"|"GENERAL_MERCHANDISE"|"MEDICAL"|"MEMBERSHIPS_CLUBS"|"PARKING_EXPENSES"|"POLITICAL_DONATIONS"|"PUBLIC_TRANSPORTATION"|"RECURRING_SOFTWARE_SAAS"|"RIDESHARE_TAXI"|"TOLL_BRIDGE_FEES"|"TRAINING_EDUCATION"|"TRAVEL")[] |null; } |null
SpendLimit.name
Section titled “SpendLimit.name”name:
string
Description
Section titled “Description”Name for the Spend Limit.
SpendLimit.owner_user_ids
Section titled “SpendLimit.owner_user_ids”owner_user_ids:
string[]
Description
Section titled “Description”User IDs of the owners of the Spend Limit.
SpendLimit.parent_budget_id?
Section titled “SpendLimit.parent_budget_id?”
optionalparent_budget_id?:string|null
Description
Section titled “Description”ID of parent Budget.
SpendLimit.period_recurrence_type
Section titled “SpendLimit.period_recurrence_type”period_recurrence_type:
"PER_MONTH"|"PER_QUARTER"|"PER_YEAR"|"ONE_TIME"|"PER_WEEK"
SpendLimit.spend_type
Section titled “SpendLimit.spend_type”spend_type:
"BUDGET_PROVISIONED_CARDS_ONLY"|"NON_BUDGET_PROVISIONED_CARDS_ALLOWED"
SpendLimit.start_date?
Section titled “SpendLimit.start_date?”
optionalstart_date?:string|null
Format: date
Description
Section titled “Description”The date when the Spend Limit should start counting.
SpendLimit.start_time_utc?
Section titled “SpendLimit.start_time_utc?”
optionalstart_time_utc?:string|null
Format: date-time
Description
Section titled “Description”The UTC time when the Spend Limit should start counting.
SpendLimit.status
Section titled “SpendLimit.status”status:
"ACTIVE"|"ARCHIVED"|"DELETED"|"EXPIRED"
SpendLimit.transaction_limit?
Section titled “SpendLimit.transaction_limit?”
optionaltransaction_limit?: {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
SpendLimitPeriodBalance
Section titled “SpendLimitPeriodBalance”SpendLimitPeriodBalance:
object
SpendLimitPeriodBalance.amount_spent?
Section titled “SpendLimitPeriodBalance.amount_spent?”
optionalamount_spent?: {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
SpendLimitPeriodBalance.end_date?
Section titled “SpendLimitPeriodBalance.end_date?”
optionalend_date?:string|null
Format: date
SpendLimitPeriodBalance.end_time?
Section titled “SpendLimitPeriodBalance.end_time?”
optionalend_time?:string|null
Format: date-time
SpendLimitPeriodBalance.rollover_amount?
Section titled “SpendLimitPeriodBalance.rollover_amount?”
optionalrollover_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
SpendLimitPeriodBalance.start_date?
Section titled “SpendLimitPeriodBalance.start_date?”
optionalstart_date?:string|null
Format: date
SpendLimitPeriodBalance.start_time?
Section titled “SpendLimitPeriodBalance.start_time?”
optionalstart_time?:string|null
Format: date-time
SpendLimitPeriodRecurrenceType
Section titled “SpendLimitPeriodRecurrenceType”SpendLimitPeriodRecurrenceType:
"PER_MONTH"|"PER_QUARTER"|"PER_YEAR"|"ONE_TIME"|"PER_WEEK"
Description
Section titled “Description”Period type of the Spend Limit e.g. MONTHLY.
SpendLimitStatus
Section titled “SpendLimitStatus”SpendLimitStatus:
"ACTIVE"|"ARCHIVED"|"DELETED"|"EXPIRED"
Description
Section titled “Description”Status of the Spend Limit e.g. ACTIVE.
SpendType
Section titled “SpendType”SpendType:
"BUDGET_PROVISIONED_CARDS_ONLY"|"NON_BUDGET_PROVISIONED_CARDS_ALLOWED"
Description
Section titled “Description”Whether this Spend Limit only can be spent from by cards provisioned by this Spend Limit.
UpdateAuthorizationSettings
Section titled “UpdateAuthorizationSettings”UpdateAuthorizationSettings:
object
UpdateAuthorizationSettings.authorization_type?
Section titled “UpdateAuthorizationSettings.authorization_type?”
optionalauthorization_type?:"HARD"|"SOFT"|null
UpdateAuthorizationSettings.base_limit?
Section titled “UpdateAuthorizationSettings.base_limit?”
optionalbase_limit?: {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
UpdateAuthorizationSettings.limit_buffer_percentage?
Section titled “UpdateAuthorizationSettings.limit_buffer_percentage?”
optionallimit_buffer_percentage?:number|null
Format: int32
Description
Section titled “Description”The percentage of flexible buffer on the limit as a 0-100 integer.
UpdateAuthorizationSettings.rollover_refresh_rate?
Section titled “UpdateAuthorizationSettings.rollover_refresh_rate?”
optionalrollover_refresh_rate?:"OFF"|"NEVER"|"PER_MONTH"|"PER_QUARTER"|"PER_YEAR"|null
UpdateBudgetBlueprintRequest
Section titled “UpdateBudgetBlueprintRequest”UpdateBudgetBlueprintRequest:
object
Description
Section titled “Description”Blueprint for provisioning Spend Limits for a Budget Program.
UpdateBudgetBlueprintRequest.description?
Section titled “UpdateBudgetBlueprintRequest.description?”
optionaldescription?:string|null
Description
Section titled “Description”Description of what the Spend Limit is used for.
UpdateBudgetBlueprintRequest.end_date?
Section titled “UpdateBudgetBlueprintRequest.end_date?”
optionalend_date?:string|null
Format: date
Description
Section titled “Description”The UTC date when the Spend Limit should stop counting.
UpdateBudgetBlueprintRequest.id?
Section titled “UpdateBudgetBlueprintRequest.id?”
optionalid?:string|null
Description
Section titled “Description”ID of budget blueprint to update, omit if adding new budget blueprint to budget program.
UpdateBudgetBlueprintRequest.limit?
Section titled “UpdateBudgetBlueprintRequest.limit?”
optionallimit?: {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
UpdateBudgetBlueprintRequest.limit_type?
Section titled “UpdateBudgetBlueprintRequest.limit_type?”
optionallimit_type?:"HARD"|"SOFT"|null
UpdateBudgetBlueprintRequest.name?
Section titled “UpdateBudgetBlueprintRequest.name?”
optionalname?:string|null
Description
Section titled “Description”Name for the Spend Limit.
UpdateBudgetBlueprintRequest.owner_user_ids?
Section titled “UpdateBudgetBlueprintRequest.owner_user_ids?”
optionalowner_user_ids?:string[] |null
Description
Section titled “Description”User IDs of the owners of the Spend Limit.
UpdateBudgetBlueprintRequest.parent_budget_id?
Section titled “UpdateBudgetBlueprintRequest.parent_budget_id?”
optionalparent_budget_id?:string|null
Description
Section titled “Description”ID of parent Budget.
UpdateBudgetBlueprintRequest.period_type?
Section titled “UpdateBudgetBlueprintRequest.period_type?”
optionalperiod_type?:"WEEKLY"|"MONTHLY"|"QUARTERLY"|"YEARLY"|"ONE_TIME"|null
UpdateBudgetBlueprintRequest.spend_type?
Section titled “UpdateBudgetBlueprintRequest.spend_type?”
optionalspend_type?:"BUDGET_PROVISIONED_CARDS_ONLY"|"NON_BUDGET_PROVISIONED_CARDS_ALLOWED"|null
UpdateBudgetBlueprintRequest.start_date?
Section titled “UpdateBudgetBlueprintRequest.start_date?”
optionalstart_date?:string|null
Format: date
Description
Section titled “Description”The UTC date when the Spend Limit should start counting.
UpdateBudgetProgramRequest
Section titled “UpdateBudgetProgramRequest”UpdateBudgetProgramRequest:
object
Description
Section titled “Description”Budget Program used to create Spend Limits for eligible users.
UpdateBudgetProgramRequest.budget_blueprints?
Section titled “UpdateBudgetProgramRequest.budget_blueprints?”
optionalbudget_blueprints?:object[] |null
Description
Section titled “Description”The Blueprints to update the budget program with. Blueprints without an ID are treated as new blueprints to be created. Blueprints that exist currently on the Budget Program, but are missing from the input, will be deleted.
UpdateBudgetProgramRequest.description?
Section titled “UpdateBudgetProgramRequest.description?”
optionaldescription?:string|null
UpdateBudgetProgramRequest.employee_filter?
Section titled “UpdateBudgetProgramRequest.employee_filter?”
optionalemployee_filter?: {employment_status?:"EMPLOYMENT_STATUS_ACTIVE"|"EMPLOYMENT_STATUS_INACTIVE"|"EMPLOYMENT_STATUS_PENDING"|null;employment_type?:"EMPLOYMENT_TYPE_FULL_TIME"|"EMPLOYMENT_TYPE_PART_TIME"|"EMPLOYMENT_TYPE_CONTRACTOR"|"EMPLOYMENT_TYPE_INTERN"|"EMPLOYMENT_TYPE_FREELANCE"|null; } |null
UpdateBudgetProgramRequest.existing_budget_ids?
Section titled “UpdateBudgetProgramRequest.existing_budget_ids?”
optionalexisting_budget_ids?:string[] |null
Description
Section titled “Description”IDs for existing Spend Limits associated with this Budget Program.
UpdateBudgetProgramRequest.name?
Section titled “UpdateBudgetProgramRequest.name?”
optionalname?:string|null
UpdateBudgetRequest
Section titled “UpdateBudgetRequest”UpdateBudgetRequest:
object
UpdateBudgetRequest.description?
Section titled “UpdateBudgetRequest.description?”
optionaldescription?:string|null
Description
Section titled “Description”Description of what the Spend Limit is used for.
UpdateBudgetRequest.end_date?
Section titled “UpdateBudgetRequest.end_date?”
optionalend_date?:string|null
Format: date
Description
Section titled “Description”The UTC date when the Spend Limit should stop counting.
UpdateBudgetRequest.limit?
Section titled “UpdateBudgetRequest.limit?”
optionallimit?: {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
UpdateBudgetRequest.limit_type?
Section titled “UpdateBudgetRequest.limit_type?”
optionallimit_type?:"HARD"|"SOFT"|null
UpdateBudgetRequest.limit_visibility?
Section titled “UpdateBudgetRequest.limit_visibility?”
optionallimit_visibility?:"PRIVATE"|"SHARED"|null
UpdateBudgetRequest.member_user_ids?
Section titled “UpdateBudgetRequest.member_user_ids?”
optionalmember_user_ids?:string[] |null
Description
Section titled “Description”User IDs of the members of the Spend Limit.
UpdateBudgetRequest.name?
Section titled “UpdateBudgetRequest.name?”
optionalname?:string|null
Description
Section titled “Description”Name for the Spend Limit.
UpdateBudgetRequest.owner_user_ids?
Section titled “UpdateBudgetRequest.owner_user_ids?”
optionalowner_user_ids?:string[] |null
Description
Section titled “Description”User IDs of the owners of the Spend Limit.
UpdateBudgetRequest.period_type?
Section titled “UpdateBudgetRequest.period_type?”
optionalperiod_type?:"WEEKLY"|"MONTHLY"|"QUARTERLY"|"YEARLY"|"ONE_TIME"|null
UpdateBudgetRequest.spend_type?
Section titled “UpdateBudgetRequest.spend_type?”
optionalspend_type?:"BUDGET_PROVISIONED_CARDS_ONLY"|"NON_BUDGET_PROVISIONED_CARDS_ALLOWED"|null
UpdateBudgetRequest.start_date?
Section titled “UpdateBudgetRequest.start_date?”
optionalstart_date?:string|null
Format: date
Description
Section titled “Description”The UTC date when the Spend Limit should start counting.
UpdateSpendBudgetRequest
Section titled “UpdateSpendBudgetRequest”UpdateSpendBudgetRequest:
object
UpdateSpendBudgetRequest.amount?
Section titled “UpdateSpendBudgetRequest.amount?”
optionalamount?: {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
UpdateSpendBudgetRequest.description?
Section titled “UpdateSpendBudgetRequest.description?”
optionaldescription?:string|null
Description
Section titled “Description”Description of what the Budget is used for.
UpdateSpendBudgetRequest.end_date?
Section titled “UpdateSpendBudgetRequest.end_date?”
optionalend_date?:string|null
Format: date
Description
Section titled “Description”The date when the Budget should stop counting.
UpdateSpendBudgetRequest.limit_type?
Section titled “UpdateSpendBudgetRequest.limit_type?”
optionallimit_type?:"HARD"|"SOFT"|null
UpdateSpendBudgetRequest.name?
Section titled “UpdateSpendBudgetRequest.name?”
optionalname?:string|null
Description
Section titled “Description”Name for the Budget.
UpdateSpendBudgetRequest.owner_user_ids?
Section titled “UpdateSpendBudgetRequest.owner_user_ids?”
optionalowner_user_ids?:string[] |null
Description
Section titled “Description”User IDs of the owners of the Budget.
UpdateSpendBudgetRequest.parent_budget_id?
Section titled “UpdateSpendBudgetRequest.parent_budget_id?”
optionalparent_budget_id?:string|null
Description
Section titled “Description”ID of parent Budget.
UpdateSpendBudgetRequest.period_recurrence_type?
Section titled “UpdateSpendBudgetRequest.period_recurrence_type?”
optionalperiod_recurrence_type?:"WEEKLY"|"MONTHLY"|"QUARTERLY"|"YEARLY"|"ONE_TIME"|null
UpdateSpendBudgetRequest.start_date?
Section titled “UpdateSpendBudgetRequest.start_date?”
optionalstart_date?:string|null
Format: date
Description
Section titled “Description”The date when the Budget should start counting.
UpdateSpendLimitRequest
Section titled “UpdateSpendLimitRequest”UpdateSpendLimitRequest:
object
UpdateSpendLimitRequest.authorization_settings?
Section titled “UpdateSpendLimitRequest.authorization_settings?”
optionalauthorization_settings?: {authorization_type?:"HARD"|"SOFT"|null;base_limit?: {amount:number;currency:string|null; } |null;limit_buffer_percentage?:number|null;rollover_refresh_rate?:"OFF"|"NEVER"|"PER_MONTH"|"PER_QUARTER"|"PER_YEAR"|null; } |null
Union Members
Section titled “Union Members”Type Literal
Section titled “Type Literal”{ authorization_type?: "HARD" | "SOFT" | null; base_limit?: { amount: number; currency: string | null; } | null; limit_buffer_percentage?: number | null; rollover_refresh_rate?: "OFF" | "NEVER" | "PER_MONTH" | "PER_QUARTER" | "PER_YEAR" | null; }
authorization_type?
Section titled “authorization_type?”
optionalauthorization_type?:"HARD"|"SOFT"|null
base_limit?
Section titled “base_limit?”
optionalbase_limit?: {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
limit_buffer_percentage?
Section titled “limit_buffer_percentage?”
optionallimit_buffer_percentage?:number|null
Format: int32
Description
Section titled “Description”The percentage of flexible buffer on the limit as a 0-100 integer.
rollover_refresh_rate?
Section titled “rollover_refresh_rate?”
optionalrollover_refresh_rate?:"OFF"|"NEVER"|"PER_MONTH"|"PER_QUARTER"|"PER_YEAR"|null
null
UpdateSpendLimitRequest.authorization_visibility?
Section titled “UpdateSpendLimitRequest.authorization_visibility?”
optionalauthorization_visibility?:"PUBLIC"|"PRIVATE"|null
UpdateSpendLimitRequest.auto_create_limit_cards_setting?
Section titled “UpdateSpendLimitRequest.auto_create_limit_cards_setting?”
optionalauto_create_limit_cards_setting?:"DISABLED"|"ALL_MEMBERS"|null
UpdateSpendLimitRequest.auto_transfer_cards_setting?
Section titled “UpdateSpendLimitRequest.auto_transfer_cards_setting?”
optionalauto_transfer_cards_setting?:"DISABLED"|"ENABLED"|null
UpdateSpendLimitRequest.department_id?
Section titled “UpdateSpendLimitRequest.department_id?”
optionaldepartment_id?:string|null
Description
Section titled “Description”The department ID to which Spend Limit expenses will be attributed.
UpdateSpendLimitRequest.description?
Section titled “UpdateSpendLimitRequest.description?”
optionaldescription?:string|null
Description
Section titled “Description”Description of what the Spend Limit is used for.
UpdateSpendLimitRequest.end_date?
Section titled “UpdateSpendLimitRequest.end_date?”
optionalend_date?:string|null
Format: date
Description
Section titled “Description”The date when the Spend Limit should expire.
UpdateSpendLimitRequest.expense_policy_id?
Section titled “UpdateSpendLimitRequest.expense_policy_id?”
optionalexpense_policy_id?:string|null
Description
Section titled “Description”The ID of the expense policy corresponding to this Spend Limit.
UpdateSpendLimitRequest.expense_visibility?
Section titled “UpdateSpendLimitRequest.expense_visibility?”
optionalexpense_visibility?:"PRIVATE"|"SHARED"|null
UpdateSpendLimitRequest.legal_entity_id?
Section titled “UpdateSpendLimitRequest.legal_entity_id?”
optionallegal_entity_id?:string|null
Description
Section titled “Description”The legal entity ID to which Spend Limit expenses will be attributed. If not set, expenses will be attributed to the spending user’s entity.
UpdateSpendLimitRequest.limit_approval_policy_id?
Section titled “UpdateSpendLimitRequest.limit_approval_policy_id?”
optionallimit_approval_policy_id?:string|null
Description
Section titled “Description”The ID of the policy for limit increase approval requests. Meant to replace limit_increase_request_policy_id.
UpdateSpendLimitRequest.limit_increase_request_policy_id?
Section titled “UpdateSpendLimitRequest.limit_increase_request_policy_id?”
optionallimit_increase_request_policy_id?:string|null
Description
Section titled “Description”The ID of the policy for limit increase requests for this Spend Limit.
UpdateSpendLimitRequest.limit_increase_setting?
Section titled “UpdateSpendLimitRequest.limit_increase_setting?”
optionallimit_increase_setting?:"DISABLED"|"ENABLED"|null
UpdateSpendLimitRequest.member_user_ids?
Section titled “UpdateSpendLimitRequest.member_user_ids?”
optionalmember_user_ids?:string[] |null
Description
Section titled “Description”User IDs of the members of the Spend Limit.
UpdateSpendLimitRequest.merchant_category_controls?
Section titled “UpdateSpendLimitRequest.merchant_category_controls?”
optionalmerchant_category_controls?: {allowed_merchant_categories?: ("ADVERTISING_MARKETING"|"GROCERY"|"TELEPHONY"|"OFFICE_SUPPLIES"|"PRIVATE_AIR_TRAVEL"|"CLOTHING"|"CAR_RENTAL"|"VEHICLE_EXPENSES"|"RESTAURANTS"|"GAMBLING"|"FLOWERS"|"ELECTRONICS"|"LEGAL_SERVICES"|"UTILITIES"|"FURNITURE"|"BARS_NIGHTLIFE"|"LAUNDRY"|"EVENT_EXPENSES"|"SHIPPING"|"OTHER_TRAVEL_EXPENSES"|"CHARITY"|"SOFTWARE"|"LODGING"|"FACILITIES_EXPENSES"|"SERVERS"|"CONFERENCES"|"FOOD_DELIVERY"|"RENT"|"AIRLINE_EXPENSES"|"OTHER_BUSINESS_EXPENSES"|"BANK_FINANCIAL_FEES"|"BOOKS_NEWSPAPERS"|"CONSULTANT_CONTRACTOR"|"CORPORATE_INSURANCE"|"DIGITAL_GOODS"|"LICENSES_TAXES"|"GAS_FUEL"|"GENERAL_MERCHANDISE"|"MEDICAL"|"MEMBERSHIPS_CLUBS"|"PARKING_EXPENSES"|"POLITICAL_DONATIONS"|"PUBLIC_TRANSPORTATION"|"RECURRING_SOFTWARE_SAAS"|"RIDESHARE_TAXI"|"TOLL_BRIDGE_FEES"|"TRAINING_EDUCATION"|"TRAVEL")[] |null;blocked_merchant_categories?: ("ADVERTISING_MARKETING"|"GROCERY"|"TELEPHONY"|"OFFICE_SUPPLIES"|"PRIVATE_AIR_TRAVEL"|"CLOTHING"|"CAR_RENTAL"|"VEHICLE_EXPENSES"|"RESTAURANTS"|"GAMBLING"|"FLOWERS"|"ELECTRONICS"|"LEGAL_SERVICES"|"UTILITIES"|"FURNITURE"|"BARS_NIGHTLIFE"|"LAUNDRY"|"EVENT_EXPENSES"|"SHIPPING"|"OTHER_TRAVEL_EXPENSES"|"CHARITY"|"SOFTWARE"|"LODGING"|"FACILITIES_EXPENSES"|"SERVERS"|"CONFERENCES"|"FOOD_DELIVERY"|"RENT"|"AIRLINE_EXPENSES"|"OTHER_BUSINESS_EXPENSES"|"BANK_FINANCIAL_FEES"|"BOOKS_NEWSPAPERS"|"CONSULTANT_CONTRACTOR"|"CORPORATE_INSURANCE"|"DIGITAL_GOODS"|"LICENSES_TAXES"|"GAS_FUEL"|"GENERAL_MERCHANDISE"|"MEDICAL"|"MEMBERSHIPS_CLUBS"|"PARKING_EXPENSES"|"POLITICAL_DONATIONS"|"PUBLIC_TRANSPORTATION"|"RECURRING_SOFTWARE_SAAS"|"RIDESHARE_TAXI"|"TOLL_BRIDGE_FEES"|"TRAINING_EDUCATION"|"TRAVEL")[] |null; } |null
UpdateSpendLimitRequest.name?
Section titled “UpdateSpendLimitRequest.name?”
optionalname?:string|null
Description
Section titled “Description”Name for the Spend Limit.
UpdateSpendLimitRequest.owner_user_ids?
Section titled “UpdateSpendLimitRequest.owner_user_ids?”
optionalowner_user_ids?:string[] |null
Description
Section titled “Description”User IDs of the owners of the Spend Limit.
UpdateSpendLimitRequest.period_recurrence_type?
Section titled “UpdateSpendLimitRequest.period_recurrence_type?”
optionalperiod_recurrence_type?:"PER_MONTH"|"PER_QUARTER"|"PER_YEAR"|"ONE_TIME"|"PER_WEEK"|null
UpdateSpendLimitRequest.set_end_date_null?
Section titled “UpdateSpendLimitRequest.set_end_date_null?”
optionalset_end_date_null?:boolean|null
Description
Section titled “Description”Set the date when the Spend Limit should expire to null.
UpdateSpendLimitRequest.set_start_date_null?
Section titled “UpdateSpendLimitRequest.set_start_date_null?”
optionalset_start_date_null?:boolean|null
Description
Section titled “Description”Set the date when the Spend Limit should start counting to null.
UpdateSpendLimitRequest.set_transaction_limit_null?
Section titled “UpdateSpendLimitRequest.set_transaction_limit_null?”
optionalset_transaction_limit_null?:boolean|null
Description
Section titled “Description”Set the transaction limit that this Spend Limit will enforce to null.
UpdateSpendLimitRequest.spend_type?
Section titled “UpdateSpendLimitRequest.spend_type?”
optionalspend_type?:"BUDGET_PROVISIONED_CARDS_ONLY"|"NON_BUDGET_PROVISIONED_CARDS_ALLOWED"|null
UpdateSpendLimitRequest.start_date?
Section titled “UpdateSpendLimitRequest.start_date?”
optionalstart_date?:string|null
Format: date
Description
Section titled “Description”The date when the Spend Limit should start counting.
UpdateSpendLimitRequest.status?
Section titled “UpdateSpendLimitRequest.status?”
optionalstatus?:"ACTIVE"|"ARCHIVED"|"DELETED"|"EXPIRED"|null
UpdateSpendLimitRequest.transaction_limit?
Section titled “UpdateSpendLimitRequest.transaction_limit?”
optionaltransaction_limit?: {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