Ramp: List child vendors of a parent vendor
Ramp vendor.getVendorChildrenListResource: arguments, response, policy and SDK examples.
← Vendor operations · Get started
Operation ramp.get_vendor_children_list_resource
Provider route: GET /developer/v1/vendors/{vendor_id}/children. 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"]["getVendorChildrenListResource"]>[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.getVendorChildrenListResource(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.get_vendor_children_list_resource(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
path | object | Required within parent | Additional keys: not allowed |
path.vendor_id | string | Required within parent | |
query | object | Optional | Additional keys: not allowed |
query.start | string | Optional | |
query.page_size | integer | Optional | Default: 20 |
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 child vendors of a parent vendor — response body |
Referenced models: List child vendors of a parent vendor — response body
Schemas
Section titled “Schemas”8 more schemas are linked from the tables above, on the schema pages.
List child vendors of a parent vendor — 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 Create a new vendor — response body |
page | Model | Required within parent | Expand List bills — response body — page Pagination details for this response. |
Referenced models: List bills — response body — page, Create a new vendor — response body
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 |
Create a new vendor — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
accounting_vendor_remote_id | JSON | Required within parent | |
accounting_vendor_remote_id (anyOf 1) | string | Alternative | The accounting remote id of the vendor. |
accounting_vendor_remote_id (anyOf 2) | null | Alternative | |
address | Model | Optional | Expand Create a new vendor — response body — address The default address of the vendor. |
addresses | array | Required within parent | The addresses of the vendor. |
addresses[] | Model | Each item | Expand Create a new vendor — response body — addresses item |
billing_frequency | string | Optional | The billing frequency for this vendor. Known values: ANNUAL, MONTHLY, MULTIPLE, NA, OTHER, QUARTERLY, ROLLING, TBD, TWICE_A_YEAR |
contacts | array | Required within parent | Unique identifiers of contacts associated with this vendor. |
contacts[] | string | Each item | Unique identifier of the vendor contact. Format: uuid |
country | string | Required within parent | The 2-letter country of the vendor. |
created_at | string | Required within parent | The date and time when this vendor was created. Format: date-time |
default_entity_id | JSON | Required within parent | |
default_entity_id (anyOf 1) | string | Alternative | Unique identifier of the default business entity associated with this vendor. Format: uuid |
default_entity_id (anyOf 2) | null | Alternative | |
default_payment_method | JSON | Required within parent | |
default_payment_method (anyOf 1) | Model | Alternative | Expand Create a new vendor — response body — default payment method policy, update source Default payment method for this vendor, including update source and policy. Read only: true |
default_payment_method (anyOf 2) | null | Alternative | |
description | string | Optional | Description of the vendor. |
display_name | JSON | Required within parent | |
display_name (anyOf 1) | string | Alternative | Display name of the vendor. |
display_name (anyOf 2) | null | Alternative | |
external_vendor_id | JSON | Required within parent | |
external_vendor_id (anyOf 1) | string | Alternative | Customer-defined external identifier for the vendor. This is independent of accounting system remote IDs. |
external_vendor_id (anyOf 2) | null | Alternative | |
federal_tax_classification | string | Optional | The federal tax classification of the vendor. Known values: C_CORPORATION, INDIVIDUAL_SOLE_PROPRIETOR_SINGLE_MEMBER_LLC, INTERNATIONAL, LLC_C_CORPORATION, LLC_PARTNERSHIP, LLC_S_CORPORATION, OTHER, PARTNERSHIP, S_CORPORATION, TRUST_ESTATE |
id | string | Required within parent | Unique identifier of the vendor. Format: uuid |
is_active | boolean | Required within parent | Whether this vendor is active. |
is_deletable | boolean | Required within parent | Whether this vendor is deletable. Read only: true |
merchant_id | string | Optional | The id of the card merchant. Format: uuid |
name | string | Required within parent | Name of the vendor. |
name_legal | string | Optional | Legal name of the vendor. |
net_payment_terms | JSON | Optional | |
net_payment_terms (anyOf 1) | JSON | Alternative | |
net_payment_terms (anyOf 1) (anyOf 1) | integer | Alternative | Number of days after receipt that payment is due. 0 means due on receipt. |
net_payment_terms (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
net_payment_terms (anyOf 2) | null | Alternative | |
parent_vendor_id | JSON | Required within parent | |
parent_vendor_id (anyOf 1) | string | Alternative | Unique identifier of the parent vendor, if this vendor has one. Format: uuid Read only: true |
parent_vendor_id (anyOf 2) | null | Alternative | |
sk_category_id | JSON | Optional | |
sk_category_id (anyOf 1) | integer | Alternative | Ramp category code of the vendor. Known values: 1, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 2, 20, 21, 23, 24, 25, 26, 27, 28, 29, 3, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 4, 40, 41, 42, 43, 44, 5, 6, 7, 8, 9 |
sk_category_id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
sk_category_name | string | Optional | The category name of the vendor. |
state | string | Optional | |
subsidiary | array | Optional | ERP subsidiary identifiers associated with this vendor. Only returned when `include_subsidiary=true`. Read only: true |
subsidiary[] | string | Each item | |
tax_address | Model | Optional | Expand Create a new vendor — response body — address The tax address of the vendor. |
total_spend_all_time | Model | Required within parent | Expand Hold Bill — response body — amount Total spend for all time for this vendor. Read only: true |
total_spend_last_30_days | Model | Required within parent | Expand Hold Bill — response body — amount Total spend for the last 30 days for this vendor. Read only: true |
total_spend_last_365_days | Model | Required within parent | Expand Hold Bill — response body — amount Total spend for the last 365 days for this vendor. Read only: true |
total_spend_ytd | Model | Required within parent | Expand Hold Bill — response body — amount Total spend year-to-date for this vendor. Read only: true |
updated_at | JSON | Required within parent | |
updated_at (anyOf 1) | string | Alternative | The date and time when this vendor was last updated. Format: date-time |
updated_at (anyOf 2) | null | Alternative | |
vendor_owner_id | JSON | Required within parent | |
vendor_owner_id (anyOf 1) | string | Alternative | Unique identifier of the user which owns this vendor. Format: uuid Read only: true |
vendor_owner_id (anyOf 2) | null | Alternative | |
vendor_type | string | Optional | The type of vendor if bill pay. Known values: BUSINESS, INDIVIDUAL |
Referenced models: Create a new vendor — response body — address, Create a new vendor — response body — addresses item, Hold Bill — response body — amount, Create a new vendor — response body — default payment method policy, update source
Create a new vendor — response body — address
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
address_line_1 | string | Required within parent | Primary address line of the vendor address. |
address_line_2 | string | Optional | Secondary address line of the vendor address. |
city | string | Required within parent | City of the vendor address. |
country | string | Required within parent | Country of the vendor address. |
postal_code | string | Required within parent | Postal or ZIP code of the vendor address. |
state | string | Optional | State or province of the vendor address. |
Create a new vendor — response body — addresses item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
address_line_1 | string | Required within parent | Primary address line of the vendor address. |
address_line_2 | string | Optional | Secondary address line of the vendor address. |
city | string | Required within parent | City of the vendor address. |
country | string | Required within parent | Country of the vendor address. |
id | string | Required within parent | Unique identifier of the vendor address. Format: uuid |
is_default | boolean | Required within parent | Whether this is the vendor's default address. Read only: true |
pay_to_name | string | Required within parent | Recipient name printed on checks mailed to this address. |
postal_code | string | Required within parent | Postal or ZIP code of the vendor address. |
state | string | Optional | State or province of the vendor address. |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: ramp.get_vendor_children_list_resource. Catalog operation: get_vendor_children_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"]