Wex Health and Benefits APIs

Sections

Theme switcher

Get Receipts For Participant

Header Parameters

X-Request-Idstring

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

Acceptstring

Controls the response media type. When application/json (the default), the response is a JSON document containing only metadata and the file content is not returned. When multipart/mixed, the response is a multipart payload in which the JSON metadata is the first part followed by the binary file content part(s).

Default value
application/json
Enum values:
application/jsonmultipart/mixed
Accept-Encodingstring

Optional. Standard HTTP Accept-Encoding header (RFC 9110 ยง12.5.3). The server honors gzip and br; any other codings listed are ignored. If the header is omitted, or none of the listed codings are honored, the response body is returned uncompressed (identity encoding).

Authorizationstring

Query Parameters

person_idstring Required

The GUID of the person (participant)

page_sizeinteger

The number of receipts requested

Minimum
1
Maximum
1000
Default value
20
indexinteger

The starting index in the list of receipts to be returned

Default value
0
number_of_months_backinteger

The number of months back from today to include receipts for. For example, a value of 3 returns receipts from the last 3 months.

Path Parameters

claim_numberstring Required

The claim number

Response

200
Object

Successfully retrieved receipts

Response Attributes

indexinteger

Current page index (i.e. page number minus one)

page_sizeinteger

Number of items per page

has_nextboolean

Indicated whether there are additional pages

total_resultsinteger

The total number of receipts matching the query across all pages. Used to calculate the total number of pages as ceil(total_results / page_size).

itemsarray | null

A list of receipts

Showย child attributes

metadataobject

Receipts object containing a list of receipts and pagination information.

Showย child attributes

file_contentarray

Binary content of each receipt file, ordered to match metadata.items. Each part's Content-Type reflects the receipt's actual file type (see metadata.items[*].content_type).

Showย child attributes

400
Object

Invalid request. Check query parameters.

Response Attributes

typestring | null
titlestring | null
statusinteger | null
detailstring | null
instancestring | null
invalid_paramsarray | null

List of invalid parameters that caused the validation error.

Max items
10

Showย child attributes

errorsobject

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

Showย child attributes

validation_errorsobject

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

401
Object

Unauthorized. Authentication failed.

Response Attributes

typestring | null
titlestring | null
statusinteger | null
detailstring | null
instancestring | null
invalid_paramsarray | null

List of invalid parameters that caused the validation error.

Max items
10

Showย child attributes

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 | null
titlestring | null
statusinteger | null
detailstring | null
instancestring | null
invalid_paramsarray | null

List of invalid parameters that caused the validation error.

Max items
10

Showย child attributes

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.

Response Attributes

typestring | null

A URI reference that identifies the problem type.

titlestring | null

A short, human-readable summary of the problem type.

statusinteger | null

The HTTP status code generated by the origin server.

detailstring | null

A human-readable explanation specific to this occurrence of the problem.

instancestring | null

A URI reference that identifies the specific occurrence of the problem.

invalid_paramsarray | null

List of invalid parameters that caused the validation error.

Max items
10

Showย child attributes

default
Object

Unexpected error

Response Attributes

typestring | null
titlestring | null
statusinteger | null
detailstring | null
instancestring | null
invalid_paramsarray | null

List of invalid parameters that caused the validation error.

Max items
10

Showย child attributes

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?

GET

/

Select
1

Response

Was this section helpful?