Skip to content

Ramp: Item receipts schemas

7 Ramp schemas with complete fields and constraints.

← Item receipts operations · All schemas

Create an item receipt — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
item_receipt_line_itemsarrayRequired within parentItem receipt line items.
item_receipt_line_items[]ModelEach itemExpand Create an item receipt — request body — body item receipt line items item
item_receipt_numberstringRequired within parentItem receipt number.
memoJSONOptional
memo (anyOf 1)stringAlternativeMemo for the item receipt.
Default: null
memo (anyOf 2)nullAlternative
purchase_order_idstringRequired within parentUnique identifier of the purchase order this item receipt is attached to.
Format: uuid
received_atstringRequired within parentThe date the vendor will deliver the goods or services.
Format: date

Referenced models: Create an item receipt — request body — body item receipt line items item

Create an item receipt — request body — body item receipt line items item

FieldTypePresenceDescription and constraints
$objectRoot
inventory_assignmentsarrayOptionalPer-lot inventory detail (lot number, quantity, expiration) for lot-tracked items; quantities must sum to unit_quantity.
inventory_assignments[]ModelEach itemExpand Create an item receipt — request body — body item receipt line items item inventory assignments item
purchase_order_line_item_idstringRequired within parentUnique identifier of the purchase order line item being received.
Format: uuid
unit_quantityJSONOptional
unit_quantity (anyOf 1)JSONAlternativeThe number of units of an item received; required for purchase order line items with inventory item accounting field selections. For expense line items, this is only applied when quantity-based expense receiving is enabled for the business and the purchase order was created through the API; otherwise the line is received in full: the receipt amount is the full purchase order line amount, and this value is saved and returned as `quantity` for reference only.
Default: null
unit_quantity (anyOf 1) (oneOf 1)stringAlternativeFormat: decimal
unit_quantity (anyOf 1) (oneOf 2)numberAlternative
unit_quantity (anyOf 2)nullAlternative

Referenced models: Create an item receipt — request body — body item receipt line items item inventory assignments item

Create an item receipt — request body — body item receipt line items item inventory assignments item

FieldTypePresenceDescription and constraints
$objectRoot
expiration_dateJSONOptional
expiration_date (anyOf 1)stringAlternativeExpiration date for this lot, if any.
Default: null
Format: date
expiration_date (anyOf 2)nullAlternative
lot_numberstringRequired within parentLot number for this portion of the received quantity.
quantityJSONRequired within parentQuantity received for this lot.
quantity (oneOf 1)stringAlternativeFormat: decimal
quantity (oneOf 2)numberAlternative

Fetch an item receipt — response body

FieldTypePresenceDescription and constraints
$objectRoot
archived_atJSONRequired within parent
archived_at (anyOf 1)stringAlternativeThe date and time when the item receipt was archived.
Format: date-time
archived_at (anyOf 2)nullAlternative
created_atstringRequired within parentThe date and time when the item receipt was created.
Format: date-time
documentsarrayRequired within parentThe URLs of the documents associated with the item receipt.
Read only: true
documents[]stringEach itemFormat: url
idstringRequired within parentThe unique identifier of the item receipt.
Format: uuid
item_receipt_numberstringRequired within parentThe user-defined identifier of the item receipt.
line_itemsarrayRequired within parentList of line items on the item receipt.
line_items[]ModelEach itemExpand Fetch an item receipt — response body — line items item
memoJSONRequired within parent
memo (anyOf 1)stringAlternativeMemo of the item receipt.
memo (anyOf 2)nullAlternative
purchase_order_idstringRequired within parentThe unique identifier of the purchase order that the item receipt belongs to.
Format: uuid
received_atstringRequired within parentThe date and time when the item receipt was received.
Format: date-time
remote_idJSONRequired within parent
remote_id (anyOf 1)stringAlternativeThe accounting remote identifier of the item receipt.
Read only: true
remote_id (anyOf 2)nullAlternative

Referenced models: Fetch an item receipt — response body — line items item

Fetch an item receipt — response body — line items item

FieldTypePresenceDescription and constraints
$objectRoot
accounting_field_selectionsarrayRequired within parentAccounting field selections for the item receipt line item.
accounting_field_selections[]ModelEach itemExpand Hold Bill — response body — accounting field selections item
amountJSONRequired within parent
amount (anyOf 1)ModelAlternativeExpand Hold Bill — response body — amount
The cost of the item receipt line item.
Read only: true
amount (anyOf 2)nullAlternative
idstringRequired within parentUnique identifier of the item receipt line item.
Format: uuid
inventory_assignmentsarrayRequired within parentPer-lot inventory detail (lot number, quantity, expiration) for lot-tracked items.
inventory_assignments[]ModelEach itemExpand Fetch an item receipt — response body — line items item inventory assignments item
memoJSONRequired within parent
memo (anyOf 1)stringAlternativeMemo of the item receipt line item.
memo (anyOf 2)nullAlternative
purchase_order_line_item_idstringRequired within parentUnique identifier of the purchase order line item that was received.
Format: uuid
quantityJSONRequired within parent
quantity (anyOf 1)JSONAlternative
quantity (anyOf 1) (anyOf 1)numberAlternativeReceived quantity of the line item.
quantity (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
quantity (anyOf 2)nullAlternative
remote_idJSONRequired within parent
remote_id (anyOf 1)stringAlternativeThe accounting remote identifier of the item receipt line item.
Read only: true
remote_id (anyOf 2)nullAlternative
unit_priceJSONRequired within parent
unit_price (anyOf 1)ModelAlternativeExpand Hold Bill — response body — amount
The cost of the item receipt line item per unit.
Read only: true
unit_price (anyOf 2)nullAlternative

Referenced models: Fetch an item receipt — response body — line items item inventory assignments item, Hold Bill — response body — accounting field selections item, Hold Bill — response body — amount

Fetch an item receipt — response body — line items item inventory assignments item

FieldTypePresenceDescription and constraints
$objectRoot
expiration_dateJSONRequired within parent
expiration_date (anyOf 1)stringAlternativeExpiration date for this lot, if any.
Format: date
expiration_date (anyOf 2)nullAlternative
idstringRequired within parentUnique identifier of the inventory assignment.
Format: uuid
lot_numberstringRequired within parentLot number for this portion of the received quantity.
quantitystringRequired within parentQuantity received for this lot.
Format: decimal

List item receipts — response body

FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parentResources returned in this page.
data[]ModelEach itemExpand Fetch an item receipt — response body
pageModelRequired within parentExpand List bills — response body — page
Pagination details for this response.

Referenced models: List bills — response body — page, Fetch an item receipt — response body

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.