Skip to content

Ramp: Link purchase orders or documents to a vendor agreement

Ramp vendor.postVendorAgreementLinkResource: arguments, response, policy and SDK examples.

← Vendor operations · Get started

Operation ramp.post_vendor_agreement_link_resource

Provider route: POST /developer/v1/vendors/agreements/{agreement_id}/link. 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["vendor"]["postVendorAgreementLinkResource"]>[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.vendor.postVendorAgreementLinkResource(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.vendor.post_vendor_agreement_link_resource(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.agreement_idstringRequired within parent
bodyModelRequired within parentExpand Link purchase orders or documents to a vendor agreement — request body — body

Referenced models: Link purchase orders or documents to a vendor agreement — 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 Link a spend request to a vendor agreement — response body

Referenced models: Link a spend request to a vendor agreement — response body

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

Link purchase orders or documents to a vendor agreement — request body — body
FieldTypePresenceDescription and constraints
$objectRoot
documentsarrayOptionalExisting documents to link to the agreement.
documents[]ModelEach itemExpand Link purchase orders or documents to a vendor agreement — request body — body documents item
purchase_order_idsarrayOptionalUnique identifiers of purchase orders to link to the agreement.
purchase_order_ids[]stringEach item

Referenced models: Link purchase orders or documents to a vendor agreement — request body — body documents item

Link a spend request to a vendor agreement — response body
FieldTypePresenceDescription and constraints
$objectRoot
agreementModelRequired within parentExpand Fetch a vendor agreement — response body
number_of_documents_linkedJSONRequired within parent
number_of_documents_linked (anyOf 1)integerAlternativeNumber of documents linked to the agreement.
number_of_documents_linked (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
number_of_purchase_orders_linkedJSONRequired within parent
number_of_purchase_orders_linked (anyOf 1)integerAlternativeNumber of purchase orders linked to the agreement.
number_of_purchase_orders_linked (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: Fetch a vendor agreement — response body

Link purchase orders or documents to a vendor agreement — request body — body documents item
FieldTypePresenceDescription and constraints
$JSONRootdiscriminator: {"mapping": {"CUSTOM_FORM_FILE": "#/components/schemas/ApiVendorAgreementCustomFormFileLinkInputRequestBody", "PAYEE_DOCUMENT": "#/components/schemas/ApiVendorAgreementPayeeDocumentLinkInputRequestBody", "SPEND_REQUEST_DOCUMENT": "#/components/schemas/ApiVendorAgreementSpendRequestDocumentLinkInputRequestBody"}, "propertyName": "type"}
$ (oneOf 1)ModelAlternativeExpand Link purchase orders or documents to a vendor agreement — request body — body documents item type CUSTOM FORM FILE
$ (oneOf 2)ModelAlternativeExpand Link purchase orders or documents to a vendor agreement — request body — body documents item type PAYEE DOCUMENT
$ (oneOf 3)ModelAlternativeExpand Link purchase orders or documents to a vendor agreement — request body — body documents item type SPEND REQUEST DOCUMENT

Referenced models: Link purchase orders or documents to a vendor agreement — request body — body documents item type CUSTOM FORM FILE, Link purchase orders or documents to a vendor agreement — request body — body documents item type PAYEE DOCUMENT, Link purchase orders or documents to a vendor agreement — request body — body documents item type SPEND REQUEST DOCUMENT

Link purchase orders or documents to a vendor agreement — request body — body documents item type CUSTOM FORM FILE
FieldTypePresenceDescription and constraints
$objectRoot
idstringRequired within parentUnique identifier of the document or file to link.
Format: uuid
typestringOptionalDocument source type.
Must equal: CUSTOM_FORM_FILE
Link purchase orders or documents to a vendor agreement — request body — body documents item type PAYEE DOCUMENT
FieldTypePresenceDescription and constraints
$objectRoot
idstringRequired within parentUnique identifier of the document or file to link.
Format: uuid
typestringOptionalDocument source type.
Must equal: PAYEE_DOCUMENT
Link purchase orders or documents to a vendor agreement — request body — body documents item type SPEND REQUEST DOCUMENT
FieldTypePresenceDescription and constraints
$objectRoot
idstringRequired within parentUnique identifier of the document or file to link.
Format: uuid
typestringOptionalDocument source type.
Must equal: SPEND_REQUEST_DOCUMENT
Fetch a vendor agreement — response body — contract owners item
FieldTypePresenceDescription and constraints
$objectRoot
emailstringRequired within parent
first_namestringRequired within parent
full_namestringRequired within parent
idstringRequired within parentFormat: uuid
last_namestringRequired within parent
profile_picture_urlJSONOptional
profile_picture_url (anyOf 1)stringAlternative
profile_picture_url (anyOf 2)nullAlternative
Fetch a vendor agreement — response body — latest rejected renewal request can view, id, reason, rejected at, unified request id, user full name
FieldTypePresenceDescription and constraints
$objectRoot
can_viewbooleanRequired within parentWhether the current user has permission to view this request.
idstringRequired within parentFormat: uuid
reasonJSONRequired within parent
reason (anyOf 1)stringAlternativeReason provided for rejecting the renewal request.
Default: null
reason (anyOf 2)nullAlternative
rejected_atJSONRequired within parent
rejected_at (anyOf 1)stringAlternativeDate when the renewal request was rejected.
Default: null
Format: date
rejected_at (anyOf 2)nullAlternative
unified_request_idstringRequired within parentFormat: uuid
user_full_namestringRequired within parentFull name of the user who submitted the renewal request.
Fetch a vendor agreement — response body — days remaining
FieldTypePresenceDescription and constraints
$objectRoot
end_date_usedJSONOptional
end_date_used (anyOf 1)stringAlternativeKnown values: END_DATE, LAST_DATE_TO_TERMINATE
end_date_used (anyOf 2)nullAlternative
is_expiredJSONOptional
is_expired (anyOf 1)booleanAlternative
is_expired (anyOf 2)nullAlternative
is_overdueJSONOptional
is_overdue (anyOf 1)booleanAlternative
is_overdue (anyOf 2)nullAlternative
num_days_until_endJSONOptional
num_days_until_end (anyOf 1)JSONAlternative
num_days_until_end (anyOf 1) (anyOf 1)integerAlternative
num_days_until_end (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
num_days_until_end (anyOf 2)nullAlternative
Fetch a vendor agreement — response body — draft spend requests item
FieldTypePresenceDescription and constraints
$objectRoot
idstringRequired within parentFormat: uuid
nameJSONOptional
name (anyOf 1)stringAlternative
name (anyOf 2)nullAlternative
sourcestringRequired within parentKnown values: EXPANSION_REQUEST, RENEWAL, REQUEST_APPROVAL, REQUEST_LINKED_TO_AGREEMENT
total_amountJSONOptional
total_amount (anyOf 1)stringAlternative
total_amount (anyOf 2)nullAlternative
unified_request_idstringRequired within parentFormat: uuid
updated_atJSONOptional
updated_at (anyOf 1)stringAlternativeFormat: date
updated_at (anyOf 2)nullAlternative
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.post_vendor_agreement_link_resource. Catalog operation: post_vendor_agreement_link_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: ["vendors: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.