Skip to content

Ramp: List item receipts

Ramp itemReceipts.getItemReceiptsResource: arguments, response, policy and SDK examples.

← Item receipts operations · Get started

Operation ramp.get_item_receipts_resource

Provider route: GET /developer/v1/item-receipts. Alter supplies the connection’s credentials and routing.

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"]["getItemReceiptsResource"]>[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.getItemReceiptsResource(input);
const result = await call.wait();
return result.bodyJson();
} finally {
await app.close();
}
}
import os
from alter_sdk import App
from 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_receipts_resource(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
queryobjectOptionalAdditional keys: not allowed
query.startstringOptional
query.page_sizeintegerOptionalDefault: 20
query.entity_idstringOptionalFormat: uuid
query.purchase_order_line_item_idstringOptionalFormat: uuid
query.purchase_order_idstringOptionalFormat: uuid
query.include_archivedbooleanOptionalDefault: false

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$ModelRootExpand List item receipts — response body

Referenced models: List item receipts — response body

1 more schema is linked from the tables above, on the schema pages.

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

List bills — response body — page
FieldTypePresenceDescription and constraints
$objectRootPagination details for a Developer API response.
nextJSONRequired within parent
next (anyOf 1)stringAlternativethe query to get to the next page; it is in the format of <BASE_URL>?<new_params>
next (anyOf 2)nullAlternative
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
Hold Bill — response body — accounting field selections item
FieldTypePresenceDescription and constraints
$objectRoot
category_infoModelRequired within parentExpand Hold Bill — response body — accounting field selections item category info
information about the accounting category (or accounting field).
display_nameJSONRequired within parent
display_name (anyOf 1)stringAlternativeCustomer-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)nullAlternative
external_codeJSONOptional
external_code (anyOf 1)stringAlternativeexternal code of accounting field option; Code field displayed on the ERP.
external_code (anyOf 2)nullAlternative
external_idstringRequired within parentexternal id of accounting field option; It should uniquely identify an accounting field option on the client end.
idstringRequired within parentID that uniquely identifies an accounting field option within Ramp
namestringRequired within parentname of accounting field option
provider_nameJSONRequired within parent
provider_name (anyOf 1)stringAlternativeName of the accounting provider
Read only: true
provider_name (anyOf 2)nullAlternative

Referenced models: Hold Bill — response body — accounting field selections item category info

Hold Bill — response body — amount
FieldTypePresenceDescription and constraints
$objectRoot
amountJSONRequired within parent
amount (anyOf 1)integerAlternativethe 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)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
currency_codestringRequired within parentThe type of currency, in ISO 4217 format. e.g. USD for US dollars
Default: USD
minor_unit_conversion_rateJSONRequired within parent
minor_unit_conversion_rate (anyOf 1)JSONAlternative
minor_unit_conversion_rate (anyOf 1) (anyOf 1)integerAlternativeThe 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)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
minor_unit_conversion_rate (anyOf 2)nullAlternative

SDK function policy ID: ramp.get_item_receipts_resource. Catalog operation: get_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:read"]

Official provider source

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.