Ramp: Fetch an item receipt
Ramp itemReceipts.getItemReceiptSingleResource: arguments, response, policy and SDK examples.
← Item receipts operations · Get started
Operation ramp.get_item_receipt_single_resource
Provider route: GET /developer/v1/item-receipts/{item_receipt_id}. 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"]["getItemReceiptSingleResource"]>[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.getItemReceiptSingleResource(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.get_item_receipt_single_resource(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
path | object | Required within parent | Additional keys: not allowed |
path.item_receipt_id | string | Required within parent | Format: uuid |
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”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 |
Hold Bill — response body — accounting field selections item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
category_info | Model | Required within parent | Expand Hold Bill — response body — accounting field selections item category info information about the accounting category (or accounting field). |
display_name | JSON | Required within parent | |
display_name (anyOf 1) | string | Alternative | Customer-set display name for the accounting field option in Ramp. When the customer renames an option inside Ramp, this returns the new label while `name` continues to return the ERP-source name. May be null if no Ramp-side override is set. |
display_name (anyOf 2) | null | Alternative | |
external_code | JSON | Optional | |
external_code (anyOf 1) | string | Alternative | external code of accounting field option; Code field displayed on the ERP. |
external_code (anyOf 2) | null | Alternative | |
external_id | string | Required within parent | external id of accounting field option; It should uniquely identify an accounting field option on the client end. |
id | string | Required within parent | ID that uniquely identifies an accounting field option within Ramp |
name | string | Required within parent | name of accounting field option |
provider_name | JSON | Required within parent | |
provider_name (anyOf 1) | string | Alternative | Name of the accounting provider Read only: true |
provider_name (anyOf 2) | null | Alternative |
Referenced models: Hold Bill — response body — accounting field selections item category info
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 |
Hold Bill — response body — accounting field selections item category info
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
external_id | string | Required within parent | external id of accounting field; It should uniquely identify an accounting field on the client end. |
id | string | Required within parent | ID that uniquely identifies an accounting field within Ramp |
name | string | Required within parent | name of accounting field |
type | string | Required within parent | accounting field type Known values: AMORTIZATION_TEMPLATE, BILLABLE, COST_CENTER, CUSTOMERS_JOBS, DEFERRAL_CODE, EXPENSE_ENTITY, GL_ACCOUNT, INVENTORY_ITEM, JOURNAL, MERCHANT, NON_ERP, OTHER, PAYROLL_PROVIDER, PROJECT, REPORTING_TAG, SALES_TAX_CODE, SUBSIDIARY, TAX_CODE, UNIT_OF_MEASURE |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: ramp.get_item_receipt_single_resource. Catalog operation: get_item_receipt_single_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:read"]