Ramp: Create an item receipt
Ramp itemReceipts.postItemReceiptsResource: arguments, response, policy and SDK examples.
← Item receipts operations · Get started
Operation ramp.post_item_receipts_resource
Provider route: POST /developer/v1/item-receipts. Alter supplies the connection’s credentials and routing.
Call through Alter
Section titled “Call through Alter”Install @alter-ai/sdk @alter-ai/ramp with npm, or alter-sdk-ramp with pip. Supply your connected customer’s grant ID and the arguments described below.
import { App } from "@alter-ai/sdk";import { RampIntegration } from "@alter-ai/ramp";
async function execute(input: Parameters<RampIntegration["itemReceipts"]["postItemReceiptsResource"]>[0]) { const app = new App({ apiKey: process.env.ALTER_API_KEY! }); try { const provider = new RampIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! }); const call = await provider.itemReceipts.postItemReceiptsResource(input); const result = await call.wait(); return result.bodyJson(); } finally { await app.close(); }}import osfrom alter_sdk import Appfrom alter_sdk_ramp import RampIntegration
async def execute(arguments): async with App(api_key=os.environ["ALTER_API_KEY"]) as app: provider = RampIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]}) call = await provider.item_receipts.post_item_receipts_resource(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
body | Model | Required within parent | Expand Create an item receipt — request body — body |
Referenced models: Create an item receipt — request body — body
Response
Section titled “Response”Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | Model | Root | Expand Fetch an item receipt — response body |
Referenced models: Fetch an item receipt — response body
Schemas
Section titled “Schemas”2 more schemas are linked from the tables above, on the schema pages.
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
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
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
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
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 — 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 |
Hold Bill — response body — amount
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
amount | JSON | Required within parent | |
amount (anyOf 1) | integer | Alternative | the amount of money represented in the smallest denomination of the currency. For example, when the currency is USD, then the amount is expressed in cents. |
amount (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
currency_code | string | Required within parent | The type of currency, in ISO 4217 format. e.g. USD for US dollars Default: USD |
minor_unit_conversion_rate | JSON | Required within parent | |
minor_unit_conversion_rate (anyOf 1) | JSON | Alternative | |
minor_unit_conversion_rate (anyOf 1) (anyOf 1) | integer | Alternative | The conversion factor to convert from the integer amount to the actual currency value. Divide amount by this value to get the real currency amount. For USD, this is 100 (e.g., 12034 / 100 = 120.34 USD). See https://docs.ramp.com/developer-api/v1/monetary-values for more information. Read only: true |
minor_unit_conversion_rate (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
minor_unit_conversion_rate (anyOf 2) | null | Alternative |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: ramp.post_item_receipts_resource. Catalog operation: post_item_receipts_resource. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.
Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.
Required provider scopes: ["item_receipts:write"]