Mercury: Receipts schemas
4 Mercury schemas with complete fields and constraints.
← Receipts operations · All schemas
Get a receipt — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Public view of a receipt and its matching state. |
createdAt | JSON | Required within parent | |
createdAt (allOf 1) | string | All variants apply | Format: yyyy-mm-ddThh:MM:ssZ |
fileName | string | Required within parent | Maximum length: 299 Minimum length: 1 |
id | JSON | Required within parent | |
id (allOf 1) | string | All variants apply | ID for the receipt Format: uuid |
matchedTransactionId | JSON | Optional | |
matchedTransactionId (anyOf 1) | JSON | Alternative | |
matchedTransactionId (anyOf 1) (allOf 1) | string | All variants apply | ID for this transaction Format: uuid |
matchedTransactionId (anyOf 1) (allOf 2) | JSON | All variants apply | The transaction this receipt was matched to, once matched. |
matchedTransactionId (anyOf 2) | null | Alternative | |
status | JSON | Required within parent | |
status (allOf 1) | string | All variants apply | Known values: pending, matched, unmatched, notAttempted, failed |
uploadedAt | JSON | Optional | |
uploadedAt (anyOf 1) | JSON | Alternative | |
uploadedAt (anyOf 1) (allOf 1) | string | All variants apply | Format: yyyy-mm-ddThh:MM:ssZ |
uploadedAt (anyOf 1) (allOf 2) | JSON | All variants apply | When Mercury began processing the direct upload; absent until matching starts. |
uploadedAt (anyOf 2) | null | Alternative |
List receipts — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A page of receipts plus the cursor for the next page. |
page | object | Required within parent | |
page.nextPage | string | Optional | ID for the receipt Format: uuid |
page.previousPage | string | Optional | ID for the receipt Format: uuid |
receipts | array | Required within parent | |
receipts[] | Model | Each item | Expand Get a receipt — response body |
Referenced models: Get a receipt — response body
Request a receipt upload URL — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Request a presigned URL to upload a receipt file. Additional keys: not allowed |
fileName | string | Required within parent | Maximum length: 299 Minimum length: 1 |
Request a receipt upload URL — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The presigned upload URL plus the id of the receipt now being tracked. Upload the file to @upload@, then start matching via the match endpoint. |
id | JSON | Required within parent | |
id (allOf 1) | string | All variants apply | ID for the receipt Format: uuid |
upload | string | Required within parent | The presigned URL to upload the receipt file to. |