Skip to content

Ramp: Fetch a vendor agreement

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

← Vendor operations · Get started

Operation ramp.get_vendor_agreement_resource

Provider route: GET /developer/v1/vendors/agreements/{agreement_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["vendor"]["getVendorAgreementResource"]>[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.getVendorAgreementResource(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.get_vendor_agreement_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

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 vendor agreement — response body

Referenced models: Fetch a vendor agreement — response body

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

Fetch a vendor agreement — response body
FieldTypePresenceDescription and constraints
$objectRoot
archived_atJSONOptional
archived_at (anyOf 1)stringAlternativeFormat: date-time
archived_at (anyOf 2)nullAlternative
auto_renewalbooleanRequired within parentWhether the agreement automatically renews.
available_actionsModelRequired within parentExpand Fetch a vendor agreement — response body — available actions
comment_thread_uuidJSONRequired within parent
comment_thread_uuid (anyOf 1)stringAlternativeUnique identifier of the comment thread for this agreement.
Default: null
comment_thread_uuid (anyOf 2)nullAlternative
contract_ownersarrayRequired within parent
contract_owners[]ModelEach itemExpand Fetch a vendor agreement — response body — contract owners item
created_atstringRequired within parentFormat: date-time
currencystringRequired within parentCurrency code for the agreement amounts.
custom_record_field_valuesarrayRequired within parent
custom_record_field_values[]ModelEach itemExpand Get a business entity — response body — custom record fields item
days_remainingModelRequired within parentExpand Fetch a vendor agreement — response body — days remaining
deleted_atJSONOptional
deleted_at (anyOf 1)stringAlternativeFormat: date-time
deleted_at (anyOf 2)nullAlternative
descriptionJSONRequired within parent
description (anyOf 1)stringAlternativeDescription of the vendor agreement.
Default: null
description (anyOf 2)nullAlternative
draft_spend_requestsarrayRequired within parent
draft_spend_requests[]ModelEach itemExpand Fetch a vendor agreement — response body — draft spend requests item
end_dateJSONRequired within parent
end_date (anyOf 1)stringAlternativeEnd date of the agreement.
Default: null
Format: date
end_date (anyOf 2)nullAlternative
has_approved_renewal_requestbooleanRequired within parentWhether an approved renewal request exists for this agreement.
idstringRequired within parentFormat: uuid
is_activebooleanRequired within parentWhether the agreement is currently active.
is_snoozedbooleanRequired within parentWhether renewal notifications for this agreement are snoozed.
is_up_for_renewalbooleanRequired within parentWhether the agreement is currently up for renewal.
last_date_to_terminateJSONRequired within parent
last_date_to_terminate (anyOf 1)stringAlternativeLast date by which the agreement can be terminated.
Default: null
Format: date
last_date_to_terminate (anyOf 2)nullAlternative
latest_rejected_renewal_requestJSONOptional
latest_rejected_renewal_request (anyOf 1)ModelAlternativeExpand Fetch a vendor agreement — response body — latest rejected renewal request can view, id, reason, rejected at, unified request id, user full name
latest_rejected_renewal_request (anyOf 2)nullAlternative
line_itemsJSONOptional
line_items (anyOf 1)arrayAlternative
line_items (anyOf 1)[]objectEach item
line_items (anyOf 2)nullAlternative
namestringRequired within parentName of the vendor agreement.
notification_trigger_groupJSONOptional
notification_trigger_group (anyOf 1)ModelAlternativeExpand Fetch a vendor agreement — response body — notification_trigger_group / type: CUSTOM SETTING, DEFAULT BUSINESS SETTING
notification_trigger_group (anyOf 2)nullAlternative
notifications_onbooleanRequired within parentWhether notifications are enabled for this agreement.
payeeModelRequired within parentExpand Fetch a vendor agreement — response body — payee
pending_spend_requestsarrayRequired within parent
pending_spend_requests[]ModelEach itemExpand Fetch a vendor agreement — response body — pending spend requests item
purchase_ordersarrayRequired within parent
purchase_orders[]ModelEach itemExpand Fetch a vendor agreement — response body — purchase orders item
ramp_event_history_idstringRequired within parentFormat: uuid
renewal_actionJSONOptional
renewal_action (anyOf 1)objectAlternative
renewal_action (anyOf 2)nullAlternative
renewal_statusstringRequired within parentKnown values: CANCELLED, EVALUATING, EXPIRED, INITIATED, NOT_STARTED, PLANNING, REJECTED, RENEWED, TERMINATED
start_dateJSONRequired within parent
start_date (anyOf 1)stringAlternativeStart date of the agreement.
Default: null
Format: date
start_date (anyOf 2)nullAlternative
total_valueModelRequired within parentExpand Hold Bill — response body — amount
updated_atstringRequired within parentFormat: date-time

Referenced models: Fetch a vendor agreement — response body — contract owners item, Fetch a vendor agreement — response body — latest rejected renewal request can view, id, reason, rejected at, unified request id, user full name, Fetch a vendor agreement — response body — days remaining, Fetch a vendor agreement — response body — draft spend requests item, Fetch a vendor agreement — response body — notification_trigger_group / type: CUSTOM SETTING, DEFAULT BUSINESS SETTING, Fetch a vendor agreement — response body — pending spend requests item, Fetch a vendor agreement — response body — purchase orders item, Hold Bill — response body — amount, Get a business entity — response body — custom record fields item, Fetch a vendor agreement — response body — available actions, Fetch a vendor agreement — response body — payee

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

SDK function policy ID: ramp.get_vendor_agreement_resource. Catalog operation: get_vendor_agreement_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: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.