Ramp: Item receipts schemas
7 Ramp schemas with complete fields and constraints.
← Item receipts operations · All schemas
Create an item receipt — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
item_receipt_line_items | array | Required within parent | Item receipt line items. |
item_receipt_line_items[] | Model | Each item | Expand Create an item receipt — request body — body item receipt line items item |
item_receipt_number | string | Required within parent | Item receipt number. |
memo | JSON | Optional | |
memo (anyOf 1) | string | Alternative | Memo for the item receipt. Default: null |
memo (anyOf 2) | null | Alternative | |
purchase_order_id | string | Required within parent | Unique identifier of the purchase order this item receipt is attached to. Format: uuid |
received_at | string | Required within parent | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
inventory_assignments | array | Optional | Per-lot inventory detail (lot number, quantity, expiration) for lot-tracked items; quantities must sum to unit_quantity. |
inventory_assignments[] | Model | Each item | Expand Create an item receipt — request body — body item receipt line items item inventory assignments item |
purchase_order_line_item_id | string | Required within parent | Unique identifier of the purchase order line item being received. Format: uuid |
unit_quantity | JSON | Optional | |
unit_quantity (anyOf 1) | JSON | Alternative | The 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) | string | Alternative | Format: decimal |
unit_quantity (anyOf 1) (oneOf 2) | number | Alternative | |
unit_quantity (anyOf 2) | null | Alternative |
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
expiration_date | JSON | Optional | |
expiration_date (anyOf 1) | string | Alternative | Expiration date for this lot, if any. Default: null Format: date |
expiration_date (anyOf 2) | null | Alternative | |
lot_number | string | Required within parent | Lot number for this portion of the received quantity. |
quantity | JSON | Required within parent | Quantity received for this lot. |
quantity (oneOf 1) | string | Alternative | Format: decimal |
quantity (oneOf 2) | number | Alternative |
Fetch an item receipt — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
archived_at | JSON | Required within parent | |
archived_at (anyOf 1) | string | Alternative | The date and time when the item receipt was archived. Format: date-time |
archived_at (anyOf 2) | null | Alternative | |
created_at | string | Required within parent | The date and time when the item receipt was created. Format: date-time |
documents | array | Required within parent | The URLs of the documents associated with the item receipt. Read only: true |
documents[] | string | Each item | Format: url |
id | string | Required within parent | The unique identifier of the item receipt. Format: uuid |
item_receipt_number | string | Required within parent | The user-defined identifier of the item receipt. |
line_items | array | Required within parent | List of line items on the item receipt. |
line_items[] | Model | Each item | Expand Fetch an item receipt — response body — line items item |
memo | JSON | Required within parent | |
memo (anyOf 1) | string | Alternative | Memo of the item receipt. |
memo (anyOf 2) | null | Alternative | |
purchase_order_id | string | Required within parent | The unique identifier of the purchase order that the item receipt belongs to. Format: uuid |
received_at | string | Required within parent | The date and time when the item receipt was received. Format: date-time |
remote_id | JSON | Required within parent | |
remote_id (anyOf 1) | string | Alternative | The accounting remote identifier of the item receipt. Read only: true |
remote_id (anyOf 2) | null | Alternative |
Referenced models: Fetch an item receipt — response body — line items item
Fetch an item receipt — response body — line items item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
accounting_field_selections | array | Required within parent | Accounting field selections for the item receipt line item. |
accounting_field_selections[] | Model | Each item | Expand Hold Bill — response body — accounting field selections item |
amount | JSON | Required within parent | |
amount (anyOf 1) | Model | Alternative | Expand Hold Bill — response body — amount The cost of the item receipt line item. Read only: true |
amount (anyOf 2) | null | Alternative | |
id | string | Required within parent | Unique identifier of the item receipt line item. Format: uuid |
inventory_assignments | array | Required within parent | Per-lot inventory detail (lot number, quantity, expiration) for lot-tracked items. |
inventory_assignments[] | Model | Each item | Expand Fetch an item receipt — response body — line items item inventory assignments item |
memo | JSON | Required within parent | |
memo (anyOf 1) | string | Alternative | Memo of the item receipt line item. |
memo (anyOf 2) | null | Alternative | |
purchase_order_line_item_id | string | Required within parent | Unique identifier of the purchase order line item that was received. Format: uuid |
quantity | JSON | Required within parent | |
quantity (anyOf 1) | JSON | Alternative | |
quantity (anyOf 1) (anyOf 1) | number | Alternative | Received quantity of the line item. |
quantity (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
quantity (anyOf 2) | null | Alternative | |
remote_id | JSON | Required within parent | |
remote_id (anyOf 1) | string | Alternative | The accounting remote identifier of the item receipt line item. Read only: true |
remote_id (anyOf 2) | null | Alternative | |
unit_price | JSON | Required within parent | |
unit_price (anyOf 1) | Model | Alternative | Expand Hold Bill — response body — amount The cost of the item receipt line item per unit. Read only: true |
unit_price (anyOf 2) | null | Alternative |
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
expiration_date | JSON | Required within parent | |
expiration_date (anyOf 1) | string | Alternative | Expiration date for this lot, if any. Format: date |
expiration_date (anyOf 2) | null | Alternative | |
id | string | Required within parent | Unique identifier of the inventory assignment. Format: uuid |
lot_number | string | Required within parent | Lot number for this portion of the received quantity. |
quantity | string | Required within parent | Quantity received for this lot. Format: decimal |
List item 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 an item 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 an item receipt — response body