Ramp: Update a single line item on an existing purchase order
Ramp purchaseOrder.patchPurchaseOrderLineItemSingleResource: arguments, response, policy and SDK examples.
← Purchase order operations · Get started
Operation ramp.patch_purchase_order_line_item_single_resource
Provider route: PATCH /developer/v1/purchase-orders/{purchase_order_id}/line-items/{line_item_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["purchaseOrder"]["patchPurchaseOrderLineItemSingleResource"]>[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.purchaseOrder.patchPurchaseOrderLineItemSingleResource(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.purchase_order.patch_purchase_order_line_item_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.line_item_id | string | Required within parent | |
path.purchase_order_id | string | Required within parent | |
body | Model | Required within parent | Expand Update a single line item on an existing purchase order — request body — body |
Referenced models: Update a single line item on an existing purchase order — 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 a purchase order — response body |
Referenced models: Fetch a purchase order — response body
Schemas
Section titled “Schemas”128 more schemas are linked from the tables above, on the schema pages.
Update a single line item on an existing purchase order — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
accounting_field_selections | array | Optional | List of accounting field options selected to code the line item. Will be updated in an 'all or nothing' manner. |
accounting_field_selections[] | Model | Each item | Expand Create a bill — request body — body accounting field selections item |
description | JSON | Optional | |
description (anyOf 1) | string | Alternative | Description of the line item. |
description (anyOf 2) | null | Alternative | |
end_date | JSON | Optional | |
end_date (anyOf 1) | string | Alternative | The date when spending for this line item ends. Omit to preserve the current date; set to null to clear it. Format: date |
end_date (anyOf 2) | null | Alternative | |
start_date | JSON | Optional | |
start_date (anyOf 1) | string | Alternative | The date when spending for this line item begins. Omit to preserve the current date; set to null to clear it. Format: date |
start_date (anyOf 2) | null | Alternative | |
unit_price | JSON | Optional | Unit price of the line item. |
unit_price (oneOf 1) | string | Alternative | Format: decimal |
unit_price (oneOf 2) | number | Alternative | |
unit_quantity | JSON | Optional | Quantity of the line item. |
unit_quantity (oneOf 1) | string | Alternative | Format: decimal |
unit_quantity (oneOf 2) | number | Alternative | |
withholding_rate | JSON | Optional | |
withholding_rate (anyOf 1) | JSON | Alternative | Retainage withholding rate for the line item, expressed as a fractional decimal. If set, this line-level rate overrides the purchase order withholding_default_rate for this line item. For example, 0.10 means 10%. Minimum: 0 Less than: 1 |
withholding_rate (anyOf 1) (oneOf 1) | string | Alternative | Format: decimal |
withholding_rate (anyOf 1) (oneOf 2) | number | Alternative | |
withholding_rate (anyOf 2) | null | Alternative |
Referenced models: Create a bill — request body — body accounting field selections item
Create a bill — request body — body accounting field selections item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
field_external_id | string | Required within parent | Remote ID of accounting field. This is the external ID, likely from ERP system. |
field_option_external_id | JSON | Optional | |
field_option_external_id (anyOf 1) | string | Alternative | Remote ID of accounting field option. This is the external ID, likely from ERP system. Required if free_form_text is not provided. Default: null |
field_option_external_id (anyOf 2) | null | Alternative | |
free_form_text | JSON | Optional | |
free_form_text (anyOf 1) | string | Alternative | Free form text for the accounting field selection. For DATE-type fields, use ISO format (YYYY-MM-DD). Required if field_option_external_id is not provided. Default: null Minimum length: 1 |
free_form_text (anyOf 2) | null | Alternative |
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
Fetch a custom form collection response by ID — response body — custom form collection response
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
custom_form_collection_log_entry | JSON | Required within parent | |
custom_form_collection_log_entry (anyOf 1) | Model | Alternative | Expand Fetch a custom form collection response by ID — response body — custom form collection response custom form collection log entry allow comments, forms, label Log entry for response to a custom form collection. |
custom_form_collection_log_entry (anyOf 2) | null | Alternative |
Referenced models: Fetch a custom form collection response by ID — response body — custom form collection response custom form collection log entry allow comments, forms, label
Fetch a purchase order — response body — line items item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
accounting_field_selections | array | Required within parent | List of accounting field options selected to code the purchase order line item. Read only: true |
accounting_field_selections[] | Model | Each item | Expand Hold Bill — response body — accounting field selections item |
amount | Model | Required within parent | Expand Hold Bill — response body — amount Amount of the line item. Read only: true |
custom_field_values | array | Required within parent | Custom field values associated with this purchase order line item. Read only: true |
custom_field_values[] | Model | Each item | Expand Fetch a purchase order — response body — line items item custom field values item |
description | JSON | Required within parent | |
description (anyOf 1) | string | Alternative | Description of the line item. |
description (anyOf 2) | null | Alternative | |
end_date | JSON | Required within parent | |
end_date (anyOf 1) | string | Alternative | The date when spending for this line item ends. Format: date |
end_date (anyOf 2) | null | Alternative | |
external_id | JSON | Required within parent | |
external_id (anyOf 1) | string | Alternative | Customer-provided external identifier of the line item. |
external_id (anyOf 2) | null | Alternative | |
id | string | Required within parent | Unique identifier for the line item. Format: uuid |
quantity | JSON | Required within parent | |
quantity (anyOf 1) | JSON | Alternative | |
quantity (anyOf 1) (anyOf 1) | number | Alternative | 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 line item. Read only: true |
remote_id (anyOf 2) | null | Alternative | |
start_date | JSON | Required within parent | |
start_date (anyOf 1) | string | Alternative | The date when spending for this line item begins. Format: date |
start_date (anyOf 2) | null | Alternative | |
unit_price | JSON | Required within parent | |
unit_price (anyOf 1) | Model | Alternative | Expand Hold Bill — response body — amount Unit price of the line item. Read only: true |
unit_price (anyOf 2) | null | Alternative | |
withholding_rate | JSON | Required within parent | |
withholding_rate (anyOf 1) | string | Alternative | Retainage withholding rate for the line item, expressed as a fractional decimal. If set, this line-level rate overrides the purchase order withholding_default_rate for this line item. For example, 0.10 means 10%. Format: decimal Maximum: 1 Minimum: 0 |
withholding_rate (anyOf 2) | null | Alternative |
Referenced models: Hold Bill — response body — accounting field selections item, Hold Bill — response body — amount, Fetch a purchase order — response body — line items item custom field values item
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.patch_purchase_order_line_item_single_resource. Catalog operation: patch_purchase_order_line_item_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: ["purchase_orders:write"]