Skip to content

Ramp: List vendor agreements

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

← Vendor operations · Get started

Operation ramp.post_vendor_agreement_list_resource

Provider route: POST /developer/v1/vendors/agreements. 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"]["postVendorAgreementListResource"]>[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.postVendorAgreementListResource(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_list_resource(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
bodyModelRequired within parentExpand List vendor agreements — request body — body

Referenced models: List vendor agreements — 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 List vendor agreements — response body

Referenced models: List vendor agreements — response body

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

List vendor agreements — request body — body
FieldTypePresenceDescription and constraints
$objectRoot
agreement_custom_recordsJSONOptional
agreement_custom_records (anyOf 1)ModelAlternativeExpand List vendor agreements — request body — body agreement custom records type and
JSON object describing custom record filters for agreements.
Schema name: CustomRecordsQueryAndClauseAdapter
agreement_custom_records (anyOf 2)nullAlternative
auto_renewsJSONOptional
auto_renews (anyOf 1)booleanAlternativeFilter by whether the agreement auto-renews.
Default: null
auto_renews (anyOf 2)nullAlternative
contract_owner_idsJSONOptional
contract_owner_ids (anyOf 1)arrayAlternativeFilter by contract owner IDs.
contract_owner_ids (anyOf 1)[]stringEach itemFormat: uuid
contract_owner_ids (anyOf 2)nullAlternative
department_idsJSONOptional
department_ids (anyOf 1)arrayAlternativeFilter by department IDs.
department_ids (anyOf 1)[]stringEach itemFormat: uuid
department_ids (anyOf 2)nullAlternative
end_date_rangeJSONOptional
end_date_range (anyOf 1)ModelAlternativeExpand List vendor agreements — request body — body end date range end, start
JSON object describing a relative end date range filter.
end_date_range (anyOf 2)nullAlternative
exclude_snoozedJSONOptional
exclude_snoozed (anyOf 1)booleanAlternativeExclude snoozed agreements when true.
Default: null
exclude_snoozed (anyOf 2)nullAlternative
has_end_dateJSONOptional
has_end_date (anyOf 1)booleanAlternativeFilter by whether the agreement has an end date.
Default: null
has_end_date (anyOf 2)nullAlternative
has_pending_expansion_requestsJSONOptional
has_pending_expansion_requests (anyOf 1)booleanAlternativeFilter by whether the agreement has pending expansion requests.
Default: null
has_pending_expansion_requests (anyOf 2)nullAlternative
has_remindersJSONOptional
has_reminders (anyOf 1)booleanAlternativeFilter by whether the agreement has reminders configured.
Default: null
has_reminders (anyOf 2)nullAlternative
include_archivedbooleanOptionalInclude archived agreements when true.
Default: false
is_activeJSONOptional
is_active (anyOf 1)booleanAlternativeFilter by whether the agreement is active.
Default: null
is_active (anyOf 2)nullAlternative
is_up_for_renewalJSONOptional
is_up_for_renewal (anyOf 1)booleanAlternativeFilter by whether the agreement is up for renewal.
Default: null
is_up_for_renewal (anyOf 2)nullAlternative
last_date_to_terminate_rangeJSONOptional
last_date_to_terminate_range (anyOf 1)ModelAlternativeExpand List vendor agreements — request body — body end date range end, start
JSON object describing a relative last date to terminate range filter.
last_date_to_terminate_range (anyOf 2)nullAlternative
max_days_remainingJSONOptional
max_days_remaining (anyOf 1)integerAlternativeFilter by agreements with days remaining less than or equal to this value.
Default: null
max_days_remaining (anyOf 2)nullAlternative
max_end_dateJSONOptional
max_end_date (anyOf 1)stringAlternativeFilter by agreements whose end date is on or before the provided date.
Default: null
Format: date
max_end_date (anyOf 2)nullAlternative
max_last_date_to_terminateJSONOptional
max_last_date_to_terminate (anyOf 1)stringAlternativeFilter by agreements whose last date to terminate is on or before the provided date.
Default: null
Format: date
max_last_date_to_terminate (anyOf 2)nullAlternative
max_start_dateJSONOptional
max_start_date (anyOf 1)stringAlternativeFilter by agreements whose start date is on or before the provided date.
Default: null
Format: date
max_start_date (anyOf 2)nullAlternative
max_total_valueJSONOptional
max_total_value (anyOf 1)JSONAlternativeFilter by agreements with total value less than or equal to this value.
Default: null
max_total_value (anyOf 1) (oneOf 1)stringAlternativeFormat: decimal
max_total_value (anyOf 1) (oneOf 2)numberAlternative
max_total_value (anyOf 2)nullAlternative
min_days_remainingJSONOptional
min_days_remaining (anyOf 1)integerAlternativeFilter by agreements with days remaining greater than or equal to this value.
Default: null
min_days_remaining (anyOf 2)nullAlternative
min_end_dateJSONOptional
min_end_date (anyOf 1)stringAlternativeFilter by agreements whose end date is on or after the provided date.
Default: null
Format: date
min_end_date (anyOf 2)nullAlternative
min_last_date_to_terminateJSONOptional
min_last_date_to_terminate (anyOf 1)stringAlternativeFilter by agreements whose last date to terminate is on or after the provided date.
Default: null
Format: date
min_last_date_to_terminate (anyOf 2)nullAlternative
min_start_dateJSONOptional
min_start_date (anyOf 1)stringAlternativeFilter by agreements whose start date is on or after the provided date.
Default: null
Format: date
min_start_date (anyOf 2)nullAlternative
min_total_valueJSONOptional
min_total_value (anyOf 1)JSONAlternativeFilter by agreements with total value greater than or equal to this value.
Default: null
min_total_value (anyOf 1) (oneOf 1)stringAlternativeFormat: decimal
min_total_value (anyOf 1) (oneOf 2)numberAlternative
min_total_value (anyOf 2)nullAlternative
page_sizeintegerOptionalThe number of results to be returned in each page. The value must be between 2 and 100. If not specified, the default value 20 will be used.
Default: 20
payee_agreement_idsJSONOptional
payee_agreement_ids (anyOf 1)arrayAlternativeFilter by agreement IDs.
payee_agreement_ids (anyOf 1)[]stringEach itemFormat: uuid
payee_agreement_ids (anyOf 2)nullAlternative
payee_idsJSONOptional
payee_ids (anyOf 1)arrayAlternativeFilter by vendor (payee) IDs.
payee_ids (anyOf 1)[]stringEach itemFormat: uuid
payee_ids (anyOf 2)nullAlternative
payee_owner_idsJSONOptional
payee_owner_ids (anyOf 1)arrayAlternativeFilter by vendor owner IDs.
payee_owner_ids (anyOf 1)[]stringEach itemFormat: uuid
payee_owner_ids (anyOf 2)nullAlternative
renewal_statusJSONOptional
renewal_status (anyOf 1)arrayAlternativeFilter by agreement renewal status.
renewal_status (anyOf 1)[]stringEach itemOne of: CANCELLED, EVALUATING, EXPIRED, INITIATED, NOT_STARTED, PLANNING, REJECTED, RENEWED, TERMINATED
renewal_status (anyOf 2)nullAlternative
renewal_status_excludeJSONOptional
renewal_status_exclude (anyOf 1)arrayAlternativeExclude agreements with these renewal statuses.
renewal_status_exclude (anyOf 1)[]stringEach itemOne of: CANCELLED, EVALUATING, EXPIRED, INITIATED, NOT_STARTED, PLANNING, REJECTED, RENEWED, TERMINATED
renewal_status_exclude (anyOf 2)nullAlternative
startstringOptionalThe ID of the last entity of the previous page, used for pagination to get the next page.
start_date_rangeJSONOptional
start_date_range (anyOf 1)ModelAlternativeExpand List vendor agreements — request body — body end date range end, start
JSON object describing a relative start date range filter.
start_date_range (anyOf 2)nullAlternative

Referenced models: List vendor agreements — request body — body agreement custom records type and, List vendor agreements — request body — body end date range end, start

List vendor agreements — response body
FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parentResources returned in this page.
data[]ModelEach itemExpand List vendor agreements — response body — data item
pageModelRequired within parentExpand List bills — response body — page
Pagination details for this response.

Referenced models: List bills — response body — page, List vendor agreements — response body — data item

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

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