Skip to content

Ramp: Update a purchase order

Ramp purchaseOrder.patchPurchaseOrderSingleResource: arguments, response, policy and SDK examples.

← Purchase order operations · Get started

Operation ramp.patch_purchase_order_single_resource

Provider route: PATCH /developer/v1/purchase-orders/{purchase_order_id}. 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["purchaseOrder"]["patchPurchaseOrderSingleResource"]>[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.patchPurchaseOrderSingleResource(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.purchase_order.patch_purchase_order_single_resource(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.purchase_order_idstringRequired within parentFormat: uuid
bodyModelRequired within parentExpand Update a purchase order — request body — body

Referenced models: Update a purchase order — request body — body

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

FieldTypePresenceDescription and constraints
$ModelRootExpand Fetch a purchase order — response body

Referenced models: Fetch a purchase order — response body

128 more schemas are linked from the tables above, on the schema pages.

Update a purchase order — request body — body
FieldTypePresenceDescription and constraints
$objectRoot
accounting_field_selectionsarrayOptionalList of accounting field options selected to code the purchase order at the body level. Will be updated in an 'all or nothing' manner. Generally, only a single vendor accounting field is supported.
accounting_field_selections[]ModelEach itemExpand Create a bill — request body — body accounting field selections item
memoJSONOptional
memo (anyOf 1)stringAlternativeMemo for the purchase order.
memo (anyOf 2)nullAlternative
nameJSONOptional
name (anyOf 1)stringAlternativeName of the purchase order. Must contain a non-whitespace character. Omit to preserve the current name, or set to null to clear it.
Pattern: \s*\S
name (anyOf 2)nullAlternative
owner_idstringOptionalUnique identifier of the new owner of the purchase order. The purchase order must be approved.
Format: uuid
spend_end_datestringOptionalThe date when spending for this purchase order ends.
Format: date
spend_start_datestringOptionalThe date when spending for this purchase order begins.
Format: date
withholding_default_rateJSONOptional
withholding_default_rate (anyOf 1)JSONAlternativeDefault retainage withholding rate for the purchase order, expressed as a fractional decimal. For example, 0.10 means 10%.
Minimum: 0
Less than: 1
withholding_default_rate (anyOf 1) (oneOf 1)stringAlternativeFormat: decimal
withholding_default_rate (anyOf 1) (oneOf 2)numberAlternative
withholding_default_rate (anyOf 2)nullAlternative

Referenced models: Create a bill — request body — body accounting field selections item

Create a bill — request body — body accounting field selections item
FieldTypePresenceDescription and constraints
$objectRoot
field_external_idstringRequired within parentRemote ID of accounting field. This is the external ID, likely from ERP system.
field_option_external_idJSONOptional
field_option_external_id (anyOf 1)stringAlternativeRemote 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)nullAlternative
free_form_textJSONOptional
free_form_text (anyOf 1)stringAlternativeFree 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)nullAlternative
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

Fetch a custom form collection response by ID — response body — custom form collection response
FieldTypePresenceDescription and constraints
$objectRoot
custom_form_collection_log_entryJSONRequired within parent
custom_form_collection_log_entry (anyOf 1)ModelAlternativeExpand 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)nullAlternative

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
FieldTypePresenceDescription and constraints
$objectRoot
accounting_field_selectionsarrayRequired within parentList of accounting field options selected to code the purchase order line item.
Read only: true
accounting_field_selections[]ModelEach itemExpand Hold Bill — response body — accounting field selections item
amountModelRequired within parentExpand Hold Bill — response body — amount
Amount of the line item.
Read only: true
custom_field_valuesarrayRequired within parentCustom field values associated with this purchase order line item.
Read only: true
custom_field_values[]ModelEach itemExpand Fetch a purchase order — response body — line items item custom field values item
descriptionJSONRequired within parent
description (anyOf 1)stringAlternativeDescription of the line item.
description (anyOf 2)nullAlternative
end_dateJSONRequired within parent
end_date (anyOf 1)stringAlternativeThe date when spending for this line item ends.
Format: date
end_date (anyOf 2)nullAlternative
external_idJSONRequired within parent
external_id (anyOf 1)stringAlternativeCustomer-provided external identifier of the line item.
external_id (anyOf 2)nullAlternative
idstringRequired within parentUnique identifier for the line item.
Format: uuid
quantityJSONRequired within parent
quantity (anyOf 1)JSONAlternative
quantity (anyOf 1) (anyOf 1)numberAlternativeQuantity 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 line item.
Read only: true
remote_id (anyOf 2)nullAlternative
start_dateJSONRequired within parent
start_date (anyOf 1)stringAlternativeThe date when spending for this line item begins.
Format: date
start_date (anyOf 2)nullAlternative
unit_priceJSONRequired within parent
unit_price (anyOf 1)ModelAlternativeExpand Hold Bill — response body — amount
Unit price of the line item.
Read only: true
unit_price (anyOf 2)nullAlternative
withholding_rateJSONRequired within parent
withholding_rate (anyOf 1)stringAlternativeRetainage 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)nullAlternative

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

Fetch a purchase order — response body — ship to address address1, address2, city, country, postal code, state
FieldTypePresenceDescription and constraints
$objectRoot
address1stringRequired within parent
address2JSONRequired within parent
address2 (anyOf 1)stringAlternativeDefault: null
address2 (anyOf 2)nullAlternative
citystringRequired within parent
countrystringRequired within parent
postal_codeJSONRequired within parent
postal_code (anyOf 1)stringAlternativeDefault: null
postal_code (anyOf 2)nullAlternative
stateJSONRequired within parent
state (anyOf 1)stringAlternativeDefault: null
state (anyOf 2)nullAlternative

SDK function policy ID: ramp.patch_purchase_order_single_resource. Catalog operation: patch_purchase_order_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"]

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.