Skip to content

Ramp: Receipt schemas

6 Ramp schemas with complete fields and constraints.

← Receipt operations · All schemas

Fetch a receipt — response body

FieldTypePresenceDescription and constraints
$objectRoot
created_atstringOptionalTimestamp when the receipt was created.
Format: date-time
idstringOptionalUnique identifier for the receipt.
Format: uuid
ocrJSONOptional
ocr (anyOf 1)ModelAlternativeExpand Fetch a receipt — response body — ocr currency code, line items, taxes
Structured data extracted from receipt OCR.
Read only: true
ocr (anyOf 2)nullAlternative
receipt_urlstringRequired within parentPre-signed URL to download receipt image (valid for 1 hour by default).
Read only: true
reimbursement_idstringOptionalReimbursement associated with this receipt.
Format: uuid
transaction_idstringOptionalTransaction associated with this receipt.
Format: uuid
user_idstringOptionalUser 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

FieldTypePresenceDescription and constraints
$objectRoot
currency_codeJSONOptional
currency_code (anyOf 1)stringAlternativeCurrency code extracted from receipt OCR. Can be null when OCR could not extract a value.
currency_code (anyOf 2)nullAlternative
line_itemsarrayOptionalLine items extracted from receipt OCR.
line_items[]ModelEach itemExpand Fetch a receipt — response body — ocr currency code, line items, taxes line items item
taxesarrayOptionalTaxes extracted from receipt OCR.
taxes[]ModelEach itemExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
item_dateJSONOptional
item_date (anyOf 1)stringAlternativeDate associated with the item extracted from receipt OCR. Can be null when OCR could not extract a value.
Format: date
item_date (anyOf 2)nullAlternative
item_nameJSONOptional
item_name (anyOf 1)stringAlternativeName of the item extracted from receipt OCR. Can be null when OCR could not extract a value.
item_name (anyOf 2)nullAlternative
item_quantityJSONOptional
item_quantity (anyOf 1)JSONAlternative
item_quantity (anyOf 1) (anyOf 1)numberAlternativeQuantity of the item extracted from receipt OCR. Can be null when OCR could not extract a value.
item_quantity (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
item_quantity (anyOf 2)nullAlternative
item_total_priceJSONOptional
item_total_price (anyOf 1)JSONAlternative
item_total_price (anyOf 1) (anyOf 1)numberAlternativeTotal 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)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
item_total_price (anyOf 2)nullAlternative
item_unit_priceJSONOptional
item_unit_price (anyOf 1)JSONAlternative
item_unit_price (anyOf 1) (anyOf 1)numberAlternativeUnit 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)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
item_unit_price (anyOf 2)nullAlternative

Fetch a receipt — response body — ocr currency code, line items, taxes taxes item

FieldTypePresenceDescription and constraints
$objectRoot
tax_amountJSONOptional
tax_amount (anyOf 1)JSONAlternative
tax_amount (anyOf 1) (anyOf 1)numberAlternativeTax amount extracted from receipt OCR. Can be null when OCR could not extract a value.
tax_amount (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
tax_amount (anyOf 2)nullAlternative
tax_nameJSONOptional
tax_name (anyOf 1)stringAlternativeName of the tax extracted from receipt OCR. Can be null when OCR could not extract a value.
tax_name (anyOf 2)nullAlternative
tax_rateJSONOptional
tax_rate (anyOf 1)JSONAlternative
tax_rate (anyOf 1) (anyOf 1)numberAlternativeTax rate extracted from receipt OCR. Can be null when OCR could not extract a value.
tax_rate (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
tax_rate (anyOf 2)nullAlternative

List receipts — response body

FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parentResources returned in this page.
data[]ModelEach itemExpand Fetch a receipt — response body
pageModelRequired within parentExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
idstringOptionalUnique identifier for the receipt.
Format: uuid

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.