Ramp: Receipt schemas
6 Ramp schemas with complete fields and constraints.
← Receipt operations · All schemas
Fetch a receipt — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
created_at | string | Optional | Timestamp when the receipt was created. Format: date-time |
id | string | Optional | Unique identifier for the receipt. Format: uuid |
ocr | JSON | Optional | |
ocr (anyOf 1) | Model | Alternative | Expand Fetch a receipt — response body — ocr currency code, line items, taxes Structured data extracted from receipt OCR. Read only: true |
ocr (anyOf 2) | null | Alternative | |
receipt_url | string | Required within parent | Pre-signed URL to download receipt image (valid for 1 hour by default). Read only: true |
reimbursement_id | string | Optional | Reimbursement associated with this receipt. Format: uuid |
transaction_id | string | Optional | Transaction associated with this receipt. Format: uuid |
user_id | string | Optional | User who uploaded the receipt. Format: uuid |
Referenced models: Fetch a receipt — response body — ocr currency code, line items, taxes
Fetch a receipt — response body — ocr currency code, line items, taxes
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
currency_code | JSON | Optional | |
currency_code (anyOf 1) | string | Alternative | Currency code extracted from receipt OCR. Can be null when OCR could not extract a value. |
currency_code (anyOf 2) | null | Alternative | |
line_items | array | Optional | Line items extracted from receipt OCR. |
line_items[] | Model | Each item | Expand Fetch a receipt — response body — ocr currency code, line items, taxes line items item |
taxes | array | Optional | Taxes extracted from receipt OCR. |
taxes[] | Model | Each item | Expand Fetch a receipt — response body — ocr currency code, line items, taxes taxes item |
Referenced models: Fetch a receipt — response body — ocr currency code, line items, taxes line items item, Fetch a receipt — response body — ocr currency code, line items, taxes taxes item
Fetch a receipt — response body — ocr currency code, line items, taxes line items item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
item_date | JSON | Optional | |
item_date (anyOf 1) | string | Alternative | Date associated with the item extracted from receipt OCR. Can be null when OCR could not extract a value. Format: date |
item_date (anyOf 2) | null | Alternative | |
item_name | JSON | Optional | |
item_name (anyOf 1) | string | Alternative | Name of the item extracted from receipt OCR. Can be null when OCR could not extract a value. |
item_name (anyOf 2) | null | Alternative | |
item_quantity | JSON | Optional | |
item_quantity (anyOf 1) | JSON | Alternative | |
item_quantity (anyOf 1) (anyOf 1) | number | Alternative | Quantity of the item extracted from receipt OCR. Can be null when OCR could not extract a value. |
item_quantity (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
item_quantity (anyOf 2) | null | Alternative | |
item_total_price | JSON | Optional | |
item_total_price (anyOf 1) | JSON | Alternative | |
item_total_price (anyOf 1) (anyOf 1) | number | Alternative | Total price of the item extracted from receipt OCR. Can be null when OCR could not extract a value. |
item_total_price (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
item_total_price (anyOf 2) | null | Alternative | |
item_unit_price | JSON | Optional | |
item_unit_price (anyOf 1) | JSON | Alternative | |
item_unit_price (anyOf 1) (anyOf 1) | number | Alternative | Unit price of the item extracted from receipt OCR. Can be null when OCR could not extract a value. |
item_unit_price (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
item_unit_price (anyOf 2) | null | Alternative |
Fetch a receipt — response body — ocr currency code, line items, taxes taxes item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
tax_amount | JSON | Optional | |
tax_amount (anyOf 1) | JSON | Alternative | |
tax_amount (anyOf 1) (anyOf 1) | number | Alternative | Tax amount extracted from receipt OCR. Can be null when OCR could not extract a value. |
tax_amount (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
tax_amount (anyOf 2) | null | Alternative | |
tax_name | JSON | Optional | |
tax_name (anyOf 1) | string | Alternative | Name of the tax extracted from receipt OCR. Can be null when OCR could not extract a value. |
tax_name (anyOf 2) | null | Alternative | |
tax_rate | JSON | Optional | |
tax_rate (anyOf 1) | JSON | Alternative | |
tax_rate (anyOf 1) (anyOf 1) | number | Alternative | Tax rate extracted from receipt OCR. Can be null when OCR could not extract a value. |
tax_rate (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
tax_rate (anyOf 2) | null | Alternative |
List receipts — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | Resources returned in this page. |
data[] | Model | Each item | Expand Fetch a receipt — response body |
page | Model | Required within parent | Expand List bills — response body — page Pagination details for this response. |
Referenced models: List bills — response body — page, Fetch a receipt — response body
Upload a receipt — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
id | string | Optional | Unique identifier for the receipt. Format: uuid |