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.
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["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 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.vendor.post_vendor_agreement_list_resource(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
body | Model | Required within parent | Expand List vendor agreements — request body — body |
Referenced models: List vendor agreements — 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 List vendor agreements — response body |
Referenced models: List vendor agreements — response body
Schemas
Section titled “Schemas”31 more schemas are linked from the tables above, on the schema pages.
List vendor agreements — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
agreement_custom_records | JSON | Optional | |
agreement_custom_records (anyOf 1) | Model | Alternative | Expand 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) | null | Alternative | |
auto_renews | JSON | Optional | |
auto_renews (anyOf 1) | boolean | Alternative | Filter by whether the agreement auto-renews. Default: null |
auto_renews (anyOf 2) | null | Alternative | |
contract_owner_ids | JSON | Optional | |
contract_owner_ids (anyOf 1) | array | Alternative | Filter by contract owner IDs. |
contract_owner_ids (anyOf 1)[] | string | Each item | Format: uuid |
contract_owner_ids (anyOf 2) | null | Alternative | |
department_ids | JSON | Optional | |
department_ids (anyOf 1) | array | Alternative | Filter by department IDs. |
department_ids (anyOf 1)[] | string | Each item | Format: uuid |
department_ids (anyOf 2) | null | Alternative | |
end_date_range | JSON | Optional | |
end_date_range (anyOf 1) | Model | Alternative | Expand 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) | null | Alternative | |
exclude_snoozed | JSON | Optional | |
exclude_snoozed (anyOf 1) | boolean | Alternative | Exclude snoozed agreements when true. Default: null |
exclude_snoozed (anyOf 2) | null | Alternative | |
has_end_date | JSON | Optional | |
has_end_date (anyOf 1) | boolean | Alternative | Filter by whether the agreement has an end date. Default: null |
has_end_date (anyOf 2) | null | Alternative | |
has_pending_expansion_requests | JSON | Optional | |
has_pending_expansion_requests (anyOf 1) | boolean | Alternative | Filter by whether the agreement has pending expansion requests. Default: null |
has_pending_expansion_requests (anyOf 2) | null | Alternative | |
has_reminders | JSON | Optional | |
has_reminders (anyOf 1) | boolean | Alternative | Filter by whether the agreement has reminders configured. Default: null |
has_reminders (anyOf 2) | null | Alternative | |
include_archived | boolean | Optional | Include archived agreements when true. Default: false |
is_active | JSON | Optional | |
is_active (anyOf 1) | boolean | Alternative | Filter by whether the agreement is active. Default: null |
is_active (anyOf 2) | null | Alternative | |
is_up_for_renewal | JSON | Optional | |
is_up_for_renewal (anyOf 1) | boolean | Alternative | Filter by whether the agreement is up for renewal. Default: null |
is_up_for_renewal (anyOf 2) | null | Alternative | |
last_date_to_terminate_range | JSON | Optional | |
last_date_to_terminate_range (anyOf 1) | Model | Alternative | Expand 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) | null | Alternative | |
max_days_remaining | JSON | Optional | |
max_days_remaining (anyOf 1) | integer | Alternative | Filter by agreements with days remaining less than or equal to this value. Default: null |
max_days_remaining (anyOf 2) | null | Alternative | |
max_end_date | JSON | Optional | |
max_end_date (anyOf 1) | string | Alternative | Filter by agreements whose end date is on or before the provided date. Default: null Format: date |
max_end_date (anyOf 2) | null | Alternative | |
max_last_date_to_terminate | JSON | Optional | |
max_last_date_to_terminate (anyOf 1) | string | Alternative | Filter 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) | null | Alternative | |
max_start_date | JSON | Optional | |
max_start_date (anyOf 1) | string | Alternative | Filter by agreements whose start date is on or before the provided date. Default: null Format: date |
max_start_date (anyOf 2) | null | Alternative | |
max_total_value | JSON | Optional | |
max_total_value (anyOf 1) | JSON | Alternative | Filter by agreements with total value less than or equal to this value. Default: null |
max_total_value (anyOf 1) (oneOf 1) | string | Alternative | Format: decimal |
max_total_value (anyOf 1) (oneOf 2) | number | Alternative | |
max_total_value (anyOf 2) | null | Alternative | |
min_days_remaining | JSON | Optional | |
min_days_remaining (anyOf 1) | integer | Alternative | Filter by agreements with days remaining greater than or equal to this value. Default: null |
min_days_remaining (anyOf 2) | null | Alternative | |
min_end_date | JSON | Optional | |
min_end_date (anyOf 1) | string | Alternative | Filter by agreements whose end date is on or after the provided date. Default: null Format: date |
min_end_date (anyOf 2) | null | Alternative | |
min_last_date_to_terminate | JSON | Optional | |
min_last_date_to_terminate (anyOf 1) | string | Alternative | Filter 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) | null | Alternative | |
min_start_date | JSON | Optional | |
min_start_date (anyOf 1) | string | Alternative | Filter by agreements whose start date is on or after the provided date. Default: null Format: date |
min_start_date (anyOf 2) | null | Alternative | |
min_total_value | JSON | Optional | |
min_total_value (anyOf 1) | JSON | Alternative | Filter by agreements with total value greater than or equal to this value. Default: null |
min_total_value (anyOf 1) (oneOf 1) | string | Alternative | Format: decimal |
min_total_value (anyOf 1) (oneOf 2) | number | Alternative | |
min_total_value (anyOf 2) | null | Alternative | |
page_size | integer | Optional | The 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_ids | JSON | Optional | |
payee_agreement_ids (anyOf 1) | array | Alternative | Filter by agreement IDs. |
payee_agreement_ids (anyOf 1)[] | string | Each item | Format: uuid |
payee_agreement_ids (anyOf 2) | null | Alternative | |
payee_ids | JSON | Optional | |
payee_ids (anyOf 1) | array | Alternative | Filter by vendor (payee) IDs. |
payee_ids (anyOf 1)[] | string | Each item | Format: uuid |
payee_ids (anyOf 2) | null | Alternative | |
payee_owner_ids | JSON | Optional | |
payee_owner_ids (anyOf 1) | array | Alternative | Filter by vendor owner IDs. |
payee_owner_ids (anyOf 1)[] | string | Each item | Format: uuid |
payee_owner_ids (anyOf 2) | null | Alternative | |
renewal_status | JSON | Optional | |
renewal_status (anyOf 1) | array | Alternative | Filter by agreement renewal status. |
renewal_status (anyOf 1)[] | string | Each item | One of: CANCELLED, EVALUATING, EXPIRED, INITIATED, NOT_STARTED, PLANNING, REJECTED, RENEWED, TERMINATED |
renewal_status (anyOf 2) | null | Alternative | |
renewal_status_exclude | JSON | Optional | |
renewal_status_exclude (anyOf 1) | array | Alternative | Exclude agreements with these renewal statuses. |
renewal_status_exclude (anyOf 1)[] | string | Each item | One of: CANCELLED, EVALUATING, EXPIRED, INITIATED, NOT_STARTED, PLANNING, REJECTED, RENEWED, TERMINATED |
renewal_status_exclude (anyOf 2) | null | Alternative | |
start | string | Optional | The ID of the last entity of the previous page, used for pagination to get the next page. |
start_date_range | JSON | Optional | |
start_date_range (anyOf 1) | Model | Alternative | Expand 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) | null | Alternative |
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | Resources returned in this page. |
data[] | Model | Each item | Expand List vendor agreements — response body — data item |
page | Model | Required within parent | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Pagination details for a Developer API response. |
next | JSON | Required within parent | |
next (anyOf 1) | string | Alternative | the query to get to the next page; it is in the format of <BASE_URL>?<new_params> |
next (anyOf 2) | null | Alternative |
Policy, approvals and errors
Section titled “Policy, approvals and errors”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"]