Wex Health and Benefits APIs

Sections

Theme switcher

Update Expense

Header Parameters

X-Request-Idstring

Optional correlation ID associated with the request, comprised of alphanumeric or hyphen characters up to 36 characters in length.

Query Parameters

person_idstring Required

The UUID of the person making the update.

Path Parameters

expense_idstring Required

The public UUID of the expense (ConsumerTrackedExpenseNbr).

Body Parameters

namestring

The display name of the expense. Maps to ExpenseName / expense_name in the database. Required in full mode. Min 3, max 25 characters.

descriptionstring

Longer free-text description of the expense. Optional. Max 500 characters. Note: this field is intentionally not persisted — the underlying stored procedure usp_UpdateConsumerTrackedExpense does not accept a description parameter. It is included here only so that limited-mode validation can reject attempts to modify it on paid/EOB expenses.

date_of_servicestring

The date the service was provided. Required in full mode.

end_date_of_servicestring

The end date of the service period (optional). Note: this field is intentionally not persisted — the underlying stored procedure does not accept an end-date parameter. It is included here only so that limited-mode validation can reject attempts to modify it on paid/EOB expenses.

amountnumber

The expense amount (out-of-pocket). Required in full mode. Must be greater than zero and >= total already allocated.

billed_amountnumber

The total amount billed by the provider (optional). If provided, must be greater than zero and >= Amount.

providerstring

The name of the provider (optional, free text).

provider_detailobject

Provider address and identifier details for an expense update. Note: only ProviderId is persisted — it maps to the alternate payee identifier. All address fields are accepted by the API but intentionally not persisted by usp_UpdateConsumerTrackedExpense, which has no address parameters.

Show child attributes

eob_numberstring

EOB reference number (optional). Note: this field is intentionally not persisted — the underlying stored procedure usp_UpdateConsumerTrackedExpense does not accept an EOB number parameter. It is included here only so that limited-mode validation can reject attempts to modify it on paid/EOB expenses.

recipientsobject

Recipient changes bundled inside an expense update request. Decouples additions from deletions so each list can be applied independently. Mirrors the explicit add/delete contract of WEX.Benefits.Claims.Application.UseCases.Expense.UpdateExpenseReceiptsDto.

Show child attributes

receiptsobject

Receipt changes for an expense update request.

Show child attributes

notesstring

Free-text notes for the expense (optional). Max 4,000 characters. This is the only field allowed in limited mode (Paid / EOB / Applied expenses).

expense_categorystring

The expense category (optional). Values mirror the Configger DB constants from stm.usp_SelectExpenseCategories. When null, the stored procedure preserves the existing category.

Response

200
Object

OK

Response Attributes

expense_idstring

The public UUID of the updated expense (ConsumerTrackedExpenseNbr). Echoed back from the route so the caller can confirm which expense was updated.

statusstring

Constant acknowledgement string. Always "updated" on success.

400
Object

Bad Request

Response Attributes

typestring
titlestring
statusinteger
detailstring
instancestring
errorsobject

Human-readable validation error messages keyed by field name. Each key maps to one or more error message strings.

validation_errorsobject

Field-level validation errors keyed by field name. Each key maps to one or more structured error details.

401
Object

Unauthorized

Response Attributes

typestring
titlestring
statusinteger
detailstring
instancestring
errorsobject

Human-readable validation error messages keyed by field name. Each key maps to one or more error message strings.

validation_errorsobject

Field-level validation errors keyed by field name. Each key maps to one or more structured error details.

404
Object

Not Found

Response Attributes

typestring
titlestring
statusinteger
detailstring
instancestring
errorsobject

Human-readable validation error messages keyed by field name. Each key maps to one or more error message strings.

validation_errorsobject

Field-level validation errors keyed by field name. Each key maps to one or more structured error details.

409
Object

Conflict

Response Attributes

typestring
titlestring
statusinteger
detailstring
instancestring
errorsobject

Human-readable validation error messages keyed by field name. Each key maps to one or more error message strings.

validation_errorsobject

Field-level validation errors keyed by field name. Each key maps to one or more structured error details.

500
Object

Internal Server Error

default
Object

Unexpected error

Response Attributes

typestring
titlestring
statusinteger
detailstring
instancestring
errorsobject

Human-readable validation error messages keyed by field name. Each key maps to one or more error message strings.

validation_errorsobject

Field-level validation errors keyed by field name. Each key maps to one or more structured error details.

Was this section helpful?

Base URL

Production:

Sandbox:

Language Box

PATCH

/

Select
1

Response

Was this section helpful?