Ramp: Vendor schemas (part 1)
84 Ramp schemas with complete fields and constraints.
← Vendor operations · All schemas
Add to a vendor's bank account details — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
account_nickname | string | Optional | Optional nickname for the payment account |
ach_details | Model | Optional | Expand Add to a vendor's bank account details — request body — body ach details ACH payment details |
crypto_details | Model | Optional | Expand Add to a vendor's bank account details — request body — body crypto details Crypto wallet (stablecoin) payout details |
is_default | boolean | Optional | Whether this should be the default payment method Default: false |
wire_details | Model | Optional | Expand Add to a vendor's bank account details — request body — body wire details Wire payment details |
Referenced models: Add to a vendor's bank account details — request body — body ach details, Add to a vendor's bank account details — request body — body crypto details, Add to a vendor's bank account details — request body — body wire details
Add to a vendor's bank account details — request body — body ach details
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
account_name | string | Optional | Account name Default: Checking Account |
account_number | string | Required within parent | ACH account number |
account_owner_type | string | Optional | Account owner type Default: BUSINESS One of: BUSINESS, INDIVIDUAL |
account_type | string | Optional | Account type Default: Checking One of: Checking, Savings |
routing_number | string | Required within parent | ACH routing number |
Add to a vendor's bank account details — request body — body crypto details
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
account_name | JSON | Optional | |
account_name (anyOf 1) | string | Alternative | Name of the wallet's account holder. Default: null |
account_name (anyOf 2) | null | Alternative | |
network | string | Required within parent | Blockchain network the wallet receives stablecoin payouts on. One of: ARBITRUM_MAINNET, AVALANCHE_MAINNET, BASE_MAINNET, ETHEREUM_MAINNET, OPTIMISM_MAINNET, PLASMA_MAINNET, POLYGON_MAINNET, SOLANA_MAINNET, STELLAR_MAINNET, SUI_MAINNET, TEMPO_MAINNET |
wallet_address | string | Required within parent | Destination crypto wallet address. |
Add to a vendor's bank account details — request body — body wire details
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
account_name | string | Optional | Account holder name. If omitted, the account is labeled Checking Account and any saved beneficiary address uses the vendor name. |
account_number | string | Required within parent | Wire account number |
beneficiary_address | Model | Optional | Expand Add to a vendor's bank account details — request body — body wire details beneficiary address Recipient's mailing address, not the bank's address. If omitted and automatic address copying is enabled for your business, the vendor's default mailing address is copied when complete and valid. If copying is disabled or no usable default exists, wire details are saved without an address. Later vendor address changes do not update this copy. |
routing_number | string | Required within parent | Wire routing number |
Referenced models: Add to a vendor's bank account details — request body — body wire details beneficiary address
Add to a vendor's bank account details — request body — body wire details beneficiary address
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
address_line_1 | string | Required within parent | Primary address line of the vendor. |
address_line_2 | JSON | Optional | |
address_line_2 (anyOf 1) | string | Alternative | Secondary address line or suite number of the vendor. |
address_line_2 (anyOf 2) | null | Alternative | |
city | string | Required within parent | City of the recipient address. Pattern: \S |
country | string | Required within parent | Two-letter ISO 3166-1 country code of the recipient address. |
postal_code | string | Required within parent | Postal or ZIP code of the recipient address. Pattern: \S |
state | JSON | Optional | |
state (anyOf 1) | string | Alternative | Address state/province abbreviation. For US addresses, use the two-letter state abbreviation, such as VA. Required for addresses in US, CA, and AU. Ignored for other countries. |
state (anyOf 2) | null | Alternative |
Add to a vendor's bank account details — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
payment_method_id | JSON | Optional | |
payment_method_id (anyOf 1) | string | Alternative | Unique identifier of the created payment method. Null when the update requires approval (status is pending_approval). Format: uuid |
payment_method_id (anyOf 2) | null | Alternative | |
payment_method_type | JSON | Optional | |
payment_method_type (anyOf 1) | string | Alternative | Type of the created payment method (e.g. ach, wire). Will be null if bank validation fails. Known values: ach, crypto, wire |
payment_method_type (anyOf 2) | null | Alternative | |
proposal_id | JSON | Optional | |
proposal_id (anyOf 1) | string | Alternative | Unique identifier of the approval proposal, if approval is required. Format: uuid |
proposal_id (anyOf 2) | null | Alternative | |
status | string | Required within parent | Status of the bank account update operation. Known values: approved, pending_approval |
vendor_id | string | Required within parent | Unique identifier of the vendor. Format: uuid |
Archive a vendor bank account — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
replacement_bank_account_id | JSON | Optional | |
replacement_bank_account_id (anyOf 1) | string | Alternative | If the bank account has associated bills, drafts, or recurring templates, provide the ID of the replacement bank account to transfer them to. Default: null Format: uuid |
replacement_bank_account_id (anyOf 2) | null | Alternative |
Create a new vendor — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
accounting_vendor_remote_id | string | Optional | The accounting remote id of the vendor. At most one of `accounting_vendor_remote_id` or `vendor_tracking_category_option_id` should be provided. The referenced accounting vendor must not already be linked to another Ramp vendor. |
acting_user_id | JSON | Optional | |
acting_user_id (anyOf 1) | string | Alternative | Deprecated and ignored. This field is accepted for backward compatibility only. Use `requesting_user_id` to control the requestor on vendor detail requests. Default: null Format: uuid |
acting_user_id (anyOf 2) | null | Alternative | |
address | Model | Optional | Expand Create a new vendor — request body — body address The address of the vendor. |
business_vendor_contacts | Model | Required within parent | Expand Create a new vendor — request body — body business vendor contacts Detailed information about the vendor contact. |
country | JSON | Optional | |
country (anyOf 1) | string | Alternative | The country of the vendor. Defaults to US when omitted or null. |
country (anyOf 2) | null | Alternative | |
default_entity_id | JSON | Optional | |
default_entity_id (anyOf 1) | string | Alternative | Unique identifier of the default business entity to associate with this vendor. Must belong to the current business. If omitted, the vendor is created without a default entity. Default: null Format: uuid |
default_entity_id (anyOf 2) | null | Alternative | |
external_vendor_id | JSON | Optional | |
external_vendor_id (anyOf 1) | string | Alternative | Customer-defined external identifier for the vendor. This is independent of accounting system remote IDs. Default: null |
external_vendor_id (anyOf 2) | null | Alternative | |
name | string | Optional | Name of the new vendor to be created. Minimum length: 1 |
net_payment_terms | JSON | Optional | |
net_payment_terms (anyOf 1) | integer | Alternative | Number of days after receipt that payment is due. 0 means due on receipt. Null clears terms; omission may inherit terms from a parent vendor. Maximum: 3652058 Minimum: 0 |
net_payment_terms (anyOf 2) | null | Alternative | |
parent_vendor_id | JSON | Optional | |
parent_vendor_id (anyOf 1) | string | Alternative | Unique identifier of the parent vendor to associate with this vendor. Default: null Format: uuid |
parent_vendor_id (anyOf 2) | null | Alternative | |
request_payment_details | boolean | Optional | Whether to request payment details from the vendor (ACH bank account, international wire transfer, and check mailing address). Requires a contact email. Default: false |
request_tax_details | boolean | Optional | Whether to request tax information from the vendor (Tax Identification Number, federal tax classification, and tax address). Requires a contact email. Default: false |
requesting_user_id | JSON | Optional | |
requesting_user_id (anyOf 1) | string | Alternative | Unique identifier of the Ramp user to record as the requestor for any payment or tax details request created during vendor creation. Defaults to existing vendor creation behavior when omitted. Requires the token user to have admin or owner privileges. Default: null Format: uuid |
requesting_user_id (anyOf 2) | null | Alternative | |
state | JSON | Optional | |
state (anyOf 1) | string | Alternative | Optional vendor-level two-letter US state abbreviation, such as VA. Ignored for non-US vendor countries. Default: null |
state (anyOf 2) | null | Alternative | |
vendor_owner_id | JSON | Optional | |
vendor_owner_id (anyOf 1) | string | Alternative | Unique identifier of the user that will own this vendor. If omitted, the vendor will be created without an owner. Default: null Format: uuid |
vendor_owner_id (anyOf 2) | null | Alternative | |
vendor_tracking_category_option_id | string | Optional | Ramp unique identifier of the accounting vendor to link to this vendor. At most one of `accounting_vendor_remote_id` or `vendor_tracking_category_option_id` should be provided. The referenced accounting vendor must not already be linked to another Ramp vendor. Format: uuid |
Referenced models: Create a new vendor — request body — body business vendor contacts, Create a new vendor — request body — body address
Create a new vendor — request body — body address
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
address_line_1 | string | Required within parent | Primary address line of the vendor. |
address_line_2 | JSON | Optional | |
address_line_2 (anyOf 1) | string | Alternative | Secondary address line or suite number of the vendor. |
address_line_2 (anyOf 2) | null | Alternative | |
city | string | Required within parent | City of the vendor address. |
country | string | Required within parent | Country of the vendor address. |
pay_to_name | JSON | Optional | |
pay_to_name (anyOf 1) | string | Alternative | Recipient name printed on checks mailed to this address. Defaults to the vendor name. Pattern: \s*\S |
pay_to_name (anyOf 2) | null | Alternative | |
postal_code | string | Required within parent | Postal or ZIP code of the vendor address. |
state | JSON | Optional | |
state (anyOf 1) | string | Alternative | Address state/province abbreviation. For US addresses, use the two-letter state abbreviation, such as VA. Required for addresses in US, CA, and AU. Ignored for other countries. |
state (anyOf 2) | null | Alternative |
Create a new vendor — request body — body business vendor contacts
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
email | string | Required within parent | |
first_name | string | Optional | |
last_name | string | Optional | |
phone | string | Optional |
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. |
Create a new vendor — response body — default payment method policy, update source
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
policy | JSON | Optional | |
policy (anyOf 1) | Model | Alternative | Expand Create a new vendor — response body — default payment method policy, update source policy value |
policy (anyOf 2) | null | Alternative | |
update_source | JSON | Optional | |
update_source (anyOf 1) | string | Alternative | Known values: AUTO, MANUAL |
update_source (anyOf 2) | null | Alternative |
Referenced models: Create a new vendor — response body — default payment method policy, update source policy value
Create a new vendor — response body — default payment method policy, update source policy value
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | discriminator: {"mapping": {"ADDRESS": "#/components/schemas/DefaultPaymentMethodAddressPolicy", "BANK_ACCOUNT": "#/components/schemas/DefaultPaymentMethodBankAccountPolicy", "CARD": "#/components/schemas/DefaultPaymentMethodCardPolicy", "DIRECT_DEBIT": "#/components/schemas/DefaultPaymentMethodDirectDebitPolicy"}, "propertyName": "kind"} |
$ (anyOf 1) | Model | Alternative | Expand Create a new vendor — response body — default payment method policy, update source policy value kind ADDRESS |
$ (anyOf 2) | Model | Alternative | Expand Create a new vendor — response body — default payment method policy, update source policy value kind BANK ACCOUNT |
$ (anyOf 3) | Model | Alternative | Expand Create a new vendor — response body — default payment method policy, update source policy value kind CARD |
$ (anyOf 4) | Model | Alternative | Expand Create a new vendor — response body — default payment method policy, update source policy value kind DIRECT DEBIT |
Referenced models: Create a new vendor — response body — default payment method policy, update source policy value kind ADDRESS, Create a new vendor — response body — default payment method policy, update source policy value kind BANK ACCOUNT, Create a new vendor — response body — default payment method policy, update source policy value kind CARD, Create a new vendor — response body — default payment method policy, update source policy value kind DIRECT DEBIT
Create a new vendor — response body — default payment method policy, update source policy value kind ADDRESS
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand Create a new vendor — response body — address |
kind | string | Required within parent | Must equal: ADDRESS |
Referenced models: Create a new vendor — response body — address
Create a new vendor — response body — default payment method policy, update source policy value kind BANK ACCOUNT
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand Create a new vendor — response body — default payment method policy, update source policy value kind BANK ACCOUNT data |
kind | string | Required within parent | Must equal: BANK_ACCOUNT |
Referenced models: Create a new vendor — response body — default payment method policy, update source policy value kind BANK ACCOUNT data
Create a new vendor — response body — default payment method policy, update source policy value kind BANK ACCOUNT data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
account_nickname | string | Optional | Nickname of the vendor bank account. |
account_number_last_four | JSON | Required within parent | |
account_number_last_four (anyOf 1) | string | Alternative | Last four digits of the bank account number. Read only: true |
account_number_last_four (anyOf 2) | null | Alternative | |
currency | string | Required within parent | Currency of the vendor bank account. Known values: AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BOV, BRL, BSD, BTN, BWP, BYN, BZD, CAD, CDF, CHE, CHF, CHW, CLF, CLP, CNH, CNY, COP, COU, CRC, CUC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, EUR, EURC, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, IRR, ISK, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRU, MUR, MVR, MWK, MXN, MXV, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, OPEN_USD, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLE, SLL, SOS, SRD, SSP, STN, SVC, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, USDB, USDC, USDG, USDT, USN, UYI, UYU, UYW, UZS, VED, VES, VND, VUV, WST, XAD, XAF, XAG, XAU, XBA, XBB, XBC, XBD, XCD, XCG, XDR, XOF, XPD, XPF, XPT, XSU, XTS, XUA, XXX, YER, ZAR, ZMW, ZWG, ZWL |
id | string | Required within parent | Unique identifier of the vendor bank account. Format: uuid |
is_default | boolean | Required within parent | Whether this is the payee's default bank account. For a pending account, whether its vendor edit makes it the default. Read only: true |
payment_method | string | Required within parent | Supported payment method for the vendor bank account. Known values: ACH, AUTOMATIC_CARD_PAYMENT, CARD, CHECK, CRYPTO_WALLET_TRANSFER, DIRECT_DEBIT, DOMESTIC_WIRE, EARLY_PAYMENT_DISCOUNT, FED_NOW, INTERNATIONAL, LOCAL_BANK_TRANSFER, ONE_TIME_CARD, ONE_TIME_CARD_DELIVERY, PAID_MANUALLY, RTP, SWIFT, UNSPECIFIED, VENDOR_CREDIT |
Create a new vendor — response body — default payment method policy, update source policy value kind CARD
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
card_payment_method | string | Required within parent | Known values: ACH, AUTOMATIC_CARD_PAYMENT, CARD, CHECK, CRYPTO_WALLET_TRANSFER, DIRECT_DEBIT, DOMESTIC_WIRE, EARLY_PAYMENT_DISCOUNT, FED_NOW, INTERNATIONAL, LOCAL_BANK_TRANSFER, ONE_TIME_CARD, ONE_TIME_CARD_DELIVERY, PAID_MANUALLY, RTP, SWIFT, UNSPECIFIED, VENDOR_CREDIT |
kind | string | Required within parent | Must equal: CARD |
Create a new vendor — response body — default payment method policy, update source policy value kind DIRECT DEBIT
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
kind | string | Required within parent | The vendor's default payment policy type. Must equal: DIRECT_DEBIT |
payment_method | string | Required within parent | The direct debit payment method for this vendor. Known values: ACH, AUTOMATIC_CARD_PAYMENT, CARD, CHECK, CRYPTO_WALLET_TRANSFER, DIRECT_DEBIT, DOMESTIC_WIRE, EARLY_PAYMENT_DISCOUNT, FED_NOW, INTERNATIONAL, LOCAL_BANK_TRANSFER, ONE_TIME_CARD, ONE_TIME_CARD_DELIVERY, PAID_MANUALLY, RTP, SWIFT, UNSPECIFIED, VENDOR_CREDIT |
Create a vendor agreement — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
auto_renewal | boolean | Required within parent | Whether the agreement automatically renews. |
contract_owner_ids | JSON | Optional | |
contract_owner_ids (anyOf 1) | array | Alternative | List of contract owner user IDs. |
contract_owner_ids (anyOf 1)[] | string | Each item | Format: uuid |
contract_owner_ids (anyOf 2) | null | Alternative | |
description | JSON | Optional | |
description (anyOf 1) | string | Alternative | Description of the vendor agreement. Default: null |
description (anyOf 2) | null | Alternative | |
end_date | JSON | Optional | |
end_date (anyOf 1) | string | Alternative | End date of the agreement. Default: null Format: date |
end_date (anyOf 2) | null | Alternative | |
last_date_to_terminate | JSON | Optional | |
last_date_to_terminate (anyOf 1) | string | Alternative | Last date by which the agreement can be terminated. Default: null Format: date |
last_date_to_terminate (anyOf 2) | null | Alternative | |
line_items | JSON | Optional | |
line_items (anyOf 1) | array | Alternative | Line items associated with the agreement. Default: null |
line_items (anyOf 1)[] | Model | Each item | Expand Create a vendor agreement — request body — body line items Line items associated with the agreement item |
line_items (anyOf 2) | null | Alternative | |
name | string | Required within parent | Name of the vendor agreement. Minimum length: 1 |
notifications_on | boolean | Required within parent | Whether notifications are enabled for this agreement. |
renewal_notification_settings | JSON | Optional | |
renewal_notification_settings (anyOf 1) | Model | Alternative | Expand Create a vendor agreement — request body — body renewal notification settings notification triggers, recipient approval group uuids, recipient dynamic user group uuids, recipient user uuids, recurring settings, scheduled enabled, should notify contract owner managers Notification settings to apply to this agreement. Default: null |
renewal_notification_settings (anyOf 2) | null | Alternative | |
start_date | string | Required within parent | Start date of the agreement. Format: date |
total_value | Model | Required within parent | Expand Create a vendor agreement — request body — body total value Total monetary value of the agreement. |
Referenced models: Create a vendor agreement — request body — body total value, Create a vendor agreement — request body — body line items Line items associated with the agreement item, Create a vendor agreement — request body — body renewal notification settings notification triggers, recipient approval group uuids, recipient dynamic user group uuids, recipient user uuids, recurring settings, scheduled enabled, should notify contract owner managers
Create a vendor agreement — request body — body line items Line items associated with the agreement item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
discount | JSON | Optional | |
discount (anyOf 1) | JSON | Alternative | Discount applied to the line item, if any. Default: null |
discount (anyOf 1) (oneOf 1) | number | Alternative | |
discount (anyOf 1) (oneOf 2) | string | Alternative | |
discount (anyOf 2) | null | Alternative | |
price_per_unit | JSON | Required within parent | Price for a single unit in the line item. |
price_per_unit (oneOf 1) | number | Alternative | |
price_per_unit (oneOf 2) | string | Alternative | |
product_or_service_name | string | Required within parent | Name of the product or service covered by the agreement line item. |
quantity | JSON | Required within parent | Quantity of units included in the line item. |
quantity (oneOf 1) | number | Alternative | |
quantity (oneOf 2) | string | Alternative | |
term | JSON | Optional | |
term (anyOf 1) | string | Alternative | Freeform term label for the line item, if applicable. Default: null |
term (anyOf 2) | null | Alternative | |
time_unit | JSON | Optional | |
time_unit (anyOf 1) | string | Alternative | Time unit associated with the line item, if applicable. Default: null |
time_unit (anyOf 2) | null | Alternative | |
total_price | JSON | Optional | |
total_price (anyOf 1) | JSON | Alternative | Total price for the line item, if provided. Default: null |
total_price (anyOf 1) (oneOf 1) | number | Alternative | |
total_price (anyOf 1) (oneOf 2) | string | Alternative | |
total_price (anyOf 2) | null | Alternative | |
unit | JSON | Optional | |
unit (anyOf 1) | string | Alternative | Unit name for the quantity, if applicable. Default: null |
unit (anyOf 2) | null | Alternative |
Create a vendor agreement — request body — body renewal notification settings notification triggers, recipient approval group uuids, recipient dynamic user group uuids, recipient user uuids, recurring settings, scheduled enabled, should notify contract owner managers
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Complete notification configuration used by create, merge, and the developer API. Omitted or null fields take their empty/false defaults; omitted or null ``recurring_settings`` disables recurrence. Omitted or null ``scheduled_enabled`` keeps the replaced group's value (true for new groups). |
notification_triggers | JSON | Optional | |
notification_triggers (anyOf 1) | array | Alternative | Default: null |
notification_triggers (anyOf 1)[] | Model | Each item | Expand Create a vendor agreement — request body — body renewal notification settings notification triggers, recipient approval group uuids, recipient dynamic user group uuids, recipient user uuids, recurring settings, scheduled enabled, should notify contract owner managers notification triggers array item |
notification_triggers (anyOf 2) | null | Alternative | |
recipient_approval_group_uuids | JSON | Optional | |
recipient_approval_group_uuids (anyOf 1) | array | Alternative | Default: null |
recipient_approval_group_uuids (anyOf 1)[] | string | Each item | |
recipient_approval_group_uuids (anyOf 2) | null | Alternative | |
recipient_dynamic_user_group_uuids | JSON | Optional | |
recipient_dynamic_user_group_uuids (anyOf 1) | array | Alternative | Default: null |
recipient_dynamic_user_group_uuids (anyOf 1)[] | string | Each item | |
recipient_dynamic_user_group_uuids (anyOf 2) | null | Alternative | |
recipient_user_uuids | JSON | Optional | |
recipient_user_uuids (anyOf 1) | array | Alternative | Default: null |
recipient_user_uuids (anyOf 1)[] | string | Each item | |
recipient_user_uuids (anyOf 2) | null | Alternative | |
recurring_settings | JSON | Optional | |
recurring_settings (anyOf 1) | Model | Alternative | Expand Create a vendor agreement — request body — body renewal notification settings notification triggers, recipient approval group uuids, recipient dynamic user group uuids, recipient user uuids, recurring settings, scheduled enabled, should notify contract owner managers recurring settings Complete recurring reminder configuration Complete recurring configuration; omission or null disables recurrence. Default: null |
recurring_settings (anyOf 2) | null | Alternative | |
scheduled_enabled | JSON | Optional | |
scheduled_enabled (anyOf 1) | boolean | Alternative | Pauses scheduled reminders when false; null preserves the current value. Default: null |
scheduled_enabled (anyOf 2) | null | Alternative | |
should_notify_contract_owner_managers | boolean | Optional | Default: false |
Referenced models: Create a vendor agreement — request body — body renewal notification settings notification triggers, recipient approval group uuids, recipient dynamic user group uuids, recipient user uuids, recurring settings, scheduled enabled, should notify contract owner managers notification triggers array item, Create a vendor agreement — request body — body renewal notification settings notification triggers, recipient approval group uuids, recipient dynamic user group uuids, recipient user uuids, recurring settings, scheduled enabled, should notify contract owner managers recurring settings Complete recurring reminder configuration
Create a vendor agreement — request body — body renewal notification settings notification triggers, recipient approval group uuids, recipient dynamic user group uuids, recipient user uuids, recurring settings, scheduled enabled, should notify contract owner managers notification triggers array item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
contract_event | string | Required within parent | One of: CONTRACT_ENDS_OR_RENEWS, CONTRACT_START_DATE, LAST_DATE_TO_TERMINATE |
days_before | integer | Required within parent |
Create a vendor agreement — request body — body renewal notification settings notification triggers, recipient approval group uuids, recipient dynamic user group uuids, recipient user uuids, recurring settings, scheduled enabled, should notify contract owner managers recurring settings Complete recurring reminder configuration
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Complete recurring reminder configuration. ``recurring_enabled`` is the on/off switch; the five ``recurring_*`` fields describe the configuration. A configured but disabled object is paused (the configuration is retained), while all-null configuration is only valid when disabled. Additional keys: not allowed |
recurring_cadence | JSON | Required within parent | |
recurring_cadence (anyOf 1) | string | Alternative | Repeat frequency, required when recurrence is enabled. BIWEEKLY means every two weeks. One of: BIWEEKLY, DAILY, MONTHLY, WEEKLY, YEARLY |
recurring_cadence (anyOf 2) | null | Alternative | |
recurring_enabled | boolean | Required within parent | On/off switch. False with a configured recurrence pauses it; must be false when recurring_start_type is null. |
recurring_max_occurrences | JSON | Required within parent | |
recurring_max_occurrences (anyOf 1) | integer | Alternative | Optional cap on the number of reminders in the series (occurrences 0..N-1 from the anchor). Null means unlimited. Greater than: 0 |
recurring_max_occurrences (anyOf 2) | null | Alternative | |
recurring_start_event | JSON | Required within parent | |
recurring_start_event (anyOf 1) | string | Alternative | Contract event anchoring recurrence; required when configured. CONTRACT_START_DATE is only valid on perpetual contracts. One of: CONTRACT_ENDS_OR_RENEWS, CONTRACT_START_DATE, LAST_DATE_TO_TERMINATE |
recurring_start_event (anyOf 2) | null | Alternative | |
recurring_start_offset_days | JSON | Required within parent | |
recurring_start_offset_days (anyOf 1) | integer | Alternative | Days relative to the contract event: negative before, zero on, positive after. Required when configured; must be 0 for CONTRACT_START_DATE. |
recurring_start_offset_days (anyOf 2) | null | Alternative | |
recurring_start_type | JSON | Required within parent | |
recurring_start_type (anyOf 1) | string | Alternative | Anchor for recurring reminders; CONTRACT_EVENT is the only value. When null, all companion fields must also be null. One of: CONTRACT_EVENT |
recurring_start_type (anyOf 2) | null | Alternative |
Create a vendor agreement — request body — body total value
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
amount | integer | Required within parent | Monetary amount in the currency's minor unit. |
currency_code | Model | Optional | Expand Edit a procurement request — request body — body currency Three-letter ISO currency code for the amount. Default: USD |
Referenced models: Edit a procurement request — request body — body currency
Create a vendor contact — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
email | string | Required within parent | Email address. Format: email |
first_name | JSON | Optional | |
first_name (anyOf 1) | string | Alternative | First name. Maximum length: 40 |
first_name (anyOf 2) | null | Alternative | |
is_default | boolean | Optional | Whether this is the default contact. Default: false |
last_name | JSON | Optional | |
last_name (anyOf 1) | string | Alternative | Last name. Maximum length: 40 |
last_name (anyOf 2) | null | Alternative | |
phone | JSON | Optional | |
phone (anyOf 1) | string | Alternative | Phone number. |
phone (anyOf 2) | null | Alternative |
Create a vendor contact — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
contact_id | JSON | Optional | |
contact_id (anyOf 1) | string | Alternative | Created contact ID. Format: uuid |
contact_id (anyOf 2) | null | Alternative | |
proposal_id | JSON | Optional | |
proposal_id (anyOf 1) | string | Alternative | Pending approval proposal ID. Format: uuid |
proposal_id (anyOf 2) | null | Alternative | |
status | string | Required within parent | Creation status. Known values: approved, pending_approval |
vendor_id | string | Required within parent | Vendor ID. Format: uuid |
Fetch a vendor agreement — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
archived_at | JSON | Optional | |
archived_at (anyOf 1) | string | Alternative | Format: date-time |
archived_at (anyOf 2) | null | Alternative | |
auto_renewal | boolean | Required within parent | Whether the agreement automatically renews. |
available_actions | Model | Required within parent | Expand Fetch a vendor agreement — response body — available actions |
comment_thread_uuid | JSON | Required within parent | |
comment_thread_uuid (anyOf 1) | string | Alternative | Unique identifier of the comment thread for this agreement. Default: null |
comment_thread_uuid (anyOf 2) | null | Alternative | |
contract_owners | array | Required within parent | |
contract_owners[] | Model | Each item | Expand Fetch a vendor agreement — response body — contract owners item |
created_at | string | Required within parent | Format: date-time |
currency | string | Required within parent | Currency code for the agreement amounts. |
custom_record_field_values | array | Required within parent | |
custom_record_field_values[] | Model | Each item | Expand Get a business entity — response body — custom record fields item |
days_remaining | Model | Required within parent | Expand Fetch a vendor agreement — response body — days remaining |
deleted_at | JSON | Optional | |
deleted_at (anyOf 1) | string | Alternative | Format: date-time |
deleted_at (anyOf 2) | null | Alternative | |
description | JSON | Required within parent | |
description (anyOf 1) | string | Alternative | Description of the vendor agreement. Default: null |
description (anyOf 2) | null | Alternative | |
draft_spend_requests | array | Required within parent | |
draft_spend_requests[] | Model | Each item | Expand Fetch a vendor agreement — response body — draft spend requests item |
end_date | JSON | Required within parent | |
end_date (anyOf 1) | string | Alternative | End date of the agreement. Default: null Format: date |
end_date (anyOf 2) | null | Alternative | |
has_approved_renewal_request | boolean | Required within parent | Whether an approved renewal request exists for this agreement. |
id | string | Required within parent | Format: uuid |
is_active | boolean | Required within parent | Whether the agreement is currently active. |
is_snoozed | boolean | Required within parent | Whether renewal notifications for this agreement are snoozed. |
is_up_for_renewal | boolean | Required within parent | Whether the agreement is currently up for renewal. |
last_date_to_terminate | JSON | Required within parent | |
last_date_to_terminate (anyOf 1) | string | Alternative | Last date by which the agreement can be terminated. Default: null Format: date |
last_date_to_terminate (anyOf 2) | null | Alternative | |
latest_rejected_renewal_request | JSON | Optional | |
latest_rejected_renewal_request (anyOf 1) | Model | Alternative | Expand 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) | null | Alternative | |
line_items | JSON | Optional | |
line_items (anyOf 1) | array | Alternative | |
line_items (anyOf 1)[] | object | Each item | |
line_items (anyOf 2) | null | Alternative | |
name | string | Required within parent | Name of the vendor agreement. |
notification_trigger_group | JSON | Optional | |
notification_trigger_group (anyOf 1) | Model | Alternative | Expand Fetch a vendor agreement — response body — notification_trigger_group / type: CUSTOM SETTING, DEFAULT BUSINESS SETTING |
notification_trigger_group (anyOf 2) | null | Alternative | |
notifications_on | boolean | Required within parent | Whether notifications are enabled for this agreement. |
payee | Model | Required within parent | Expand Fetch a vendor agreement — response body — payee |
pending_spend_requests | array | Required within parent | |
pending_spend_requests[] | Model | Each item | Expand Fetch a vendor agreement — response body — pending spend requests item |
purchase_orders | array | Required within parent | |
purchase_orders[] | Model | Each item | Expand Fetch a vendor agreement — response body — purchase orders item |
ramp_event_history_id | string | Required within parent | Format: uuid |
renewal_action | JSON | Optional | |
renewal_action (anyOf 1) | object | Alternative | |
renewal_action (anyOf 2) | null | Alternative | |
renewal_status | string | Required within parent | Known values: CANCELLED, EVALUATING, EXPIRED, INITIATED, NOT_STARTED, PLANNING, REJECTED, RENEWED, TERMINATED |
start_date | JSON | Required within parent | |
start_date (anyOf 1) | string | Alternative | Start date of the agreement. Default: null Format: date |
start_date (anyOf 2) | null | Alternative | |
total_value | Model | Required within parent | Expand Hold Bill — response body — amount |
updated_at | string | Required within parent | Format: 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 — available actions
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
can_action | Model | Required within parent | Expand Fetch a vendor agreement — response body — available actions can action Whether the user may perform lifecycle actions on the agreement. |
can_edit | Model | Required within parent | Expand Fetch a vendor agreement — response body — available actions can edit Whether the agreement may be edited. |
delete | Model | Required within parent | Expand Fetch a vendor agreement — response body — available actions delete Whether the agreement may be deleted. |
request_expansion | Model | Required within parent | Expand Fetch a vendor agreement — response body — available actions request expansion Whether an expansion may be requested for the agreement. |
request_renewal | Model | Required within parent | Expand Fetch a vendor agreement — response body — available actions request renewal Whether a renewal may be requested for the agreement. |
send_reminder | JSON | Required within parent | Whether a manual contract reminder may be sent. discriminator: {"mapping": {"allowed": "#/components/schemas/ActionAllowedSchema", "denied": "#/components/schemas/SendManualReminderDeniedSchema"}, "propertyName": "status"} |
send_reminder (anyOf 1) | Model | Alternative | Expand Fetch a vendor agreement — response body — available actions delete status allowed |
send_reminder (anyOf 2) | Model | Alternative | Expand Fetch a vendor agreement — response body — available actions send reminder status denied |
set_status | Model | Required within parent | Expand Fetch a vendor agreement — response body — available actions set status Whether the agreement's renewal status may be changed. |
Referenced models: Fetch a vendor agreement — response body — available actions delete status allowed, Fetch a vendor agreement — response body — available actions can action, Fetch a vendor agreement — response body — available actions delete, Fetch a vendor agreement — response body — available actions can edit, Fetch a vendor agreement — response body — available actions request expansion, Fetch a vendor agreement — response body — available actions request renewal, Fetch a vendor agreement — response body — available actions set status, Fetch a vendor agreement — response body — available actions send reminder status denied
Fetch a vendor agreement — response body — available actions can action
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | discriminator: {"mapping": {"allowed": "#/components/schemas/ActionAllowedSchema", "denied": "#/components/schemas/ActionDeniedSchema_AgreementActionDenialReason_"}, "propertyName": "status"} |
$ (anyOf 1) | Model | Alternative | Expand Fetch a vendor agreement — response body — available actions delete status allowed |
$ (anyOf 2) | Model | Alternative | Expand Fetch a vendor agreement — response body — available_actions / can_action / denial_reason: NO PERMISSION, status denied |
Referenced models: Fetch a vendor agreement — response body — available actions delete status allowed, Fetch a vendor agreement — response body — available_actions / can_action / denial_reason: NO PERMISSION, status denied
Fetch a vendor agreement — response body — available actions can edit
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | discriminator: {"mapping": {"allowed": "#/components/schemas/ActionAllowedSchema", "denied": "#/components/schemas/ActionDeniedSchema_EditAgreementDenialReason_"}, "propertyName": "status"} |
$ (anyOf 1) | Model | Alternative | Expand Fetch a vendor agreement — response body — available actions delete status allowed |
$ (anyOf 2) | Model | Alternative | Expand Fetch a vendor agreement — response body — available_actions / can_edit / denial_reason: NOT CONTRACT OWNER, NOT VENDOR OWNER, NO PERMISSION, status denied |
Referenced models: Fetch a vendor agreement — response body — available actions delete status allowed, Fetch a vendor agreement — response body — available_actions / can_edit / denial_reason: NOT CONTRACT OWNER, NOT VENDOR OWNER, NO PERMISSION, status denied
Fetch a vendor agreement — response body — available actions delete
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | discriminator: {"mapping": {"allowed": "#/components/schemas/ActionAllowedSchema", "denied": "#/components/schemas/ActionDeniedSchema_DeleteRenewalDenialReason_"}, "propertyName": "status"} |
$ (anyOf 1) | Model | Alternative | Expand Fetch a vendor agreement — response body — available actions delete status allowed |
$ (anyOf 2) | Model | Alternative | Expand Fetch a vendor agreement — response body — available_actions / delete / denial_reason: APPROVED REQUEST, PENDING REQUEST, REJECTED REQUEST, status denied |
Referenced models: Fetch a vendor agreement — response body — available actions delete status allowed, Fetch a vendor agreement — response body — available_actions / delete / denial_reason: APPROVED REQUEST, PENDING REQUEST, REJECTED REQUEST, status denied
Fetch a vendor agreement — response body — available actions delete status allowed
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
status | string | Required within parent | Must equal: allowed |
Fetch a vendor agreement — response body — available actions request expansion
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | discriminator: {"mapping": {"allowed": "#/components/schemas/ActionAllowedSchema", "denied": "#/components/schemas/ActionDeniedSchema_RequestExpansionDenialReason_"}, "propertyName": "status"} |
$ (anyOf 1) | Model | Alternative | Expand Fetch a vendor agreement — response body — available actions delete status allowed |
$ (anyOf 2) | Model | Alternative | Expand Fetch a vendor agreement — response body — available actions request expansion status denied |
Referenced models: Fetch a vendor agreement — response body — available actions delete status allowed, Fetch a vendor agreement — response body — available actions request expansion status denied
Fetch a vendor agreement — response body — available actions request expansion status denied
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
denial_reason | string | Required within parent | Why the action cannot be performed. Known values: APPROVED_RENEWAL_REQUEST, MARKED_AS_RENEWED, MARKED_AS_TERMINATED, NO_PERMISSION, PENDING_EXPANSION_REQUEST, PENDING_RENEWAL_REQUEST |
status | string | Required within parent | Whether the action can be performed. Must equal: denied |
Fetch a vendor agreement — response body — available actions request renewal
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | discriminator: {"mapping": {"allowed": "#/components/schemas/ActionAllowedSchema", "denied": "#/components/schemas/ActionDeniedSchema_RequestRenewalDenialReason_"}, "propertyName": "status"} |
$ (anyOf 1) | Model | Alternative | Expand Fetch a vendor agreement — response body — available actions delete status allowed |
$ (anyOf 2) | Model | Alternative | Expand Fetch a vendor agreement — response body — available actions request renewal status denied |
Referenced models: Fetch a vendor agreement — response body — available actions delete status allowed, Fetch a vendor agreement — response body — available actions request renewal status denied
Fetch a vendor agreement — response body — available actions request renewal status denied
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
denial_reason | string | Required within parent | Why the action cannot be performed. Known values: APPROVED_RENEWAL_REQUEST, CONTRACT_TYPE_NOT_RENEWABLE, MARKED_AS_RENEWED, MARKED_AS_TERMINATED, MARKED_AS_WONT_RENEW, NO_PERMISSION, PENDING_EXPANSION_REQUEST, PENDING_RENEWAL_REQUEST |
status | string | Required within parent | Whether the action can be performed. Must equal: denied |
Fetch a vendor agreement — response body — available actions send reminder status denied
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Denied manual reminder action, with the time the cooldown ends |
available_at | JSON | Required within parent | |
available_at (anyOf 1) | string | Alternative | When a manual reminder can be sent again. Set only when the denial reason is IN_COOLDOWN. Default: null Format: date-time |
available_at (anyOf 2) | null | Alternative | |
denial_reason | string | Required within parent | Why the action cannot be performed. Known values: ARCHIVED, FEATURE_DISABLED, INELIGIBLE_STATUS, IN_COOLDOWN, MISSING_REQUIRED_INFO, NOTIFICATIONS_OFF, NO_PERMISSION, NO_RECIPIENTS, SNOOZED |
status | string | Required within parent | Whether the action can be performed. Must equal: denied |
Fetch a vendor agreement — response body — available actions set status
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | discriminator: {"mapping": {"allowed": "#/components/schemas/ActionAllowedSchema", "denied": "#/components/schemas/ActionDeniedSchema_SetRenewalStatusDenialReason_"}, "propertyName": "status"} |
$ (anyOf 1) | Model | Alternative | Expand Fetch a vendor agreement — response body — available actions delete status allowed |
$ (anyOf 2) | Model | Alternative | Expand Fetch a vendor agreement — response body — available_actions / set_status / denial_reason: APPROVED RENEWAL REQUEST, NO PERMISSION, PENDING RENEWAL REQUEST, status denied |
Referenced models: Fetch a vendor agreement — response body — available actions delete status allowed, Fetch a vendor agreement — response body — available_actions / set_status / denial_reason: APPROVED RENEWAL REQUEST, NO PERMISSION, PENDING RENEWAL REQUEST, status denied
Fetch a vendor agreement — response body — available_actions / can_action / denial_reason: NO PERMISSION, status denied
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
denial_reason | string | Required within parent | Why the action cannot be performed. Known values: NO_PERMISSION |
status | string | Required within parent | Whether the action can be performed. Must equal: denied |
Fetch a vendor agreement — response body — available_actions / can_edit / denial_reason: NOT CONTRACT OWNER, NOT VENDOR OWNER, NO PERMISSION, status denied
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
denial_reason | string | Required within parent | Why the action cannot be performed. Known values: NOT_CONTRACT_OWNER, NOT_VENDOR_OWNER, NO_PERMISSION |
status | string | Required within parent | Whether the action can be performed. Must equal: denied |
Fetch a vendor agreement — response body — available_actions / delete / denial_reason: APPROVED REQUEST, PENDING REQUEST, REJECTED REQUEST, status denied
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
denial_reason | string | Required within parent | Why the action cannot be performed. Known values: APPROVED_REQUEST, PENDING_REQUEST, REJECTED_REQUEST |
status | string | Required within parent | Whether the action can be performed. Must equal: denied |
Fetch a vendor agreement — response body — available_actions / set_status / denial_reason: APPROVED RENEWAL REQUEST, NO PERMISSION, PENDING RENEWAL REQUEST, status denied
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
denial_reason | string | Required within parent | Why the action cannot be performed. Known values: APPROVED_RENEWAL_REQUEST, NO_PERMISSION, PENDING_RENEWAL_REQUEST |
status | string | Required within parent | Whether the action can be performed. Must equal: denied |
Fetch a vendor agreement — response body — contract owners item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
email | string | Required within parent | |
first_name | string | Required within parent | |
full_name | string | Required within parent | |
id | string | Required within parent | Format: uuid |
last_name | string | Required within parent | |
profile_picture_url | JSON | Optional | |
profile_picture_url (anyOf 1) | string | Alternative | |
profile_picture_url (anyOf 2) | null | Alternative |
Fetch a vendor agreement — response body — days remaining
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
end_date_used | JSON | Optional | |
end_date_used (anyOf 1) | string | Alternative | Known values: END_DATE, LAST_DATE_TO_TERMINATE |
end_date_used (anyOf 2) | null | Alternative | |
is_expired | JSON | Optional | |
is_expired (anyOf 1) | boolean | Alternative | |
is_expired (anyOf 2) | null | Alternative | |
is_overdue | JSON | Optional | |
is_overdue (anyOf 1) | boolean | Alternative | |
is_overdue (anyOf 2) | null | Alternative | |
num_days_until_end | JSON | Optional | |
num_days_until_end (anyOf 1) | JSON | Alternative | |
num_days_until_end (anyOf 1) (anyOf 1) | integer | Alternative | |
num_days_until_end (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
num_days_until_end (anyOf 2) | null | Alternative |
Fetch a vendor agreement — response body — draft spend requests item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
id | string | Required within parent | Format: uuid |
name | JSON | Optional | |
name (anyOf 1) | string | Alternative | |
name (anyOf 2) | null | Alternative | |
source | string | Required within parent | Known values: EXPANSION_REQUEST, RENEWAL, REQUEST_APPROVAL, REQUEST_LINKED_TO_AGREEMENT |
total_amount | JSON | Optional | |
total_amount (anyOf 1) | string | Alternative | |
total_amount (anyOf 2) | null | Alternative | |
unified_request_id | string | Required within parent | Format: uuid |
updated_at | JSON | Optional | |
updated_at (anyOf 1) | string | Alternative | Format: date |
updated_at (anyOf 2) | null | Alternative |
Fetch a vendor agreement — response body — latest rejected renewal request can view, id, reason, rejected at, unified request id, user full name
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
can_view | boolean | Required within parent | Whether the current user has permission to view this request. |
id | string | Required within parent | Format: uuid |
reason | JSON | Required within parent | |
reason (anyOf 1) | string | Alternative | Reason provided for rejecting the renewal request. Default: null |
reason (anyOf 2) | null | Alternative | |
rejected_at | JSON | Required within parent | |
rejected_at (anyOf 1) | string | Alternative | Date when the renewal request was rejected. Default: null Format: date |
rejected_at (anyOf 2) | null | Alternative | |
unified_request_id | string | Required within parent | Format: uuid |
user_full_name | string | Required within parent | Full name of the user who submitted the renewal request. |
Fetch a vendor agreement — response body — notification_trigger_group / type: CUSTOM SETTING, DEFAULT BUSINESS SETTING
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
id | string | Required within parent | Unique identifier for the notification trigger group. |
notification_triggers | array | Required within parent | |
notification_triggers[] | Model | Each item | Expand Fetch a vendor agreement — response body — notification_trigger_group / type: CUSTOM SETTING, DEFAULT BUSINESS SETTING notification triggers item |
payee_business_settings_id | JSON | Required within parent | |
payee_business_settings_id (anyOf 1) | JSON | Alternative | |
payee_business_settings_id (anyOf 1) (anyOf 1) | integer | Alternative | Identifier for the associated payee business settings, if any. Default: null |
payee_business_settings_id (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
payee_business_settings_id (anyOf 2) | null | Alternative | |
recipient_approval_groups | array | Required within parent | |
recipient_approval_groups[] | Model | Each item | Expand Fetch a vendor agreement — response body — notification_trigger_group / type: CUSTOM SETTING, DEFAULT BUSINESS SETTING recipient approval groups item |
recipient_users | array | Required within parent | |
recipient_users[] | Model | Each item | Expand Fetch a vendor agreement — response body — notification_trigger_group / type: CUSTOM SETTING, DEFAULT BUSINESS SETTING recipient users item |
should_notify_vendor_owner_manager | boolean | Required within parent | Deprecated. Always false; vendor owner managers are not notified. |
type | string | Required within parent | Known values: CUSTOM_SETTING, DEFAULT_BUSINESS_SETTING |
Referenced models: Fetch a vendor agreement — response body — notification_trigger_group / type: CUSTOM SETTING, DEFAULT BUSINESS SETTING recipient approval groups item, Fetch a vendor agreement — response body — notification_trigger_group / type: CUSTOM SETTING, DEFAULT BUSINESS SETTING recipient users item, Fetch a vendor agreement — response body — notification_trigger_group / type: CUSTOM SETTING, DEFAULT BUSINESS SETTING notification triggers item
Fetch a vendor agreement — response body — notification_trigger_group / type: CUSTOM SETTING, DEFAULT BUSINESS SETTING notification triggers item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
contract_event | string | Required within parent | Known values: CONTRACT_ENDS_OR_RENEWS, CONTRACT_START_DATE, LAST_DATE_TO_TERMINATE |
days_before | JSON | Required within parent | |
days_before (anyOf 1) | integer | Alternative | Number of days before the contract event to trigger notification. |
days_before (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
id | string | Required within parent | Unique identifier for the notification trigger. |
Fetch a vendor agreement — response body — notification_trigger_group / type: CUSTOM SETTING, DEFAULT BUSINESS SETTING recipient approval groups item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
id | string | Required within parent | Format: uuid |
members | array | Required within parent | |
members[] | Model | Each item | Expand Fetch a vendor agreement — response body — notification_trigger_group / type: CUSTOM SETTING, DEFAULT BUSINESS SETTING recipient approval groups item members item |
name | string | Required within parent | Name of the recipient group. |
Referenced models: Fetch a vendor agreement — response body — notification_trigger_group / type: CUSTOM SETTING, DEFAULT BUSINESS SETTING recipient approval groups item members item
Fetch a vendor agreement — response body — notification_trigger_group / type: CUSTOM SETTING, DEFAULT BUSINESS SETTING recipient approval groups item members item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
member | Model | Required within parent | Expand Fetch a vendor agreement — response body — notification_trigger_group / type: CUSTOM SETTING, DEFAULT BUSINESS SETTING recipient users item |
Referenced models: Fetch a vendor agreement — response body — notification_trigger_group / type: CUSTOM SETTING, DEFAULT BUSINESS SETTING recipient users item
Fetch a vendor agreement — response body — notification_trigger_group / type: CUSTOM SETTING, DEFAULT BUSINESS SETTING recipient users item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
full_name | string | Required within parent | Full name of the user. |
id | string | Required within parent | Format: uuid |
Fetch a vendor agreement — response body — payee
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
approval_instance_uuid | JSON | Required within parent | |
approval_instance_uuid (anyOf 1) | string | Alternative | |
approval_instance_uuid (anyOf 2) | null | Alternative | |
approval_status | string | Required within parent | Known values: APPROVED, PENDING, REJECTED |
available_actions | Model | Required within parent | Expand Fetch a vendor agreement — response body — payee available actions |
business_vendor | JSON | Required within parent | |
business_vendor (anyOf 1) | Model | Alternative | Expand Fetch a vendor agreement — response body — payee business vendor uuid, vendor tracking category option id |
business_vendor (anyOf 2) | null | Alternative | |
card_merchants | array | Required within parent | |
card_merchants[] | Model | Each item | Expand Fetch a vendor agreement — response body — payee card merchants item |
dba_name | JSON | Required within parent | |
dba_name (anyOf 1) | string | Alternative | |
dba_name (anyOf 2) | null | Alternative | |
deleted_at | JSON | Required within parent | |
deleted_at (anyOf 1) | string | Alternative | Format: date-time |
deleted_at (anyOf 2) | null | Alternative | |
image_url | JSON | Required within parent | |
image_url (anyOf 1) | string | Alternative | |
image_url (anyOf 2) | null | Alternative | |
is_draft | boolean | Required within parent | |
name | string | Required within parent | |
owners | array | Required within parent | |
owners[] | Model | Each item | Expand Fetch a vendor agreement — response body — payee owners item |
uuid | string | Required within parent | |
website | JSON | Required within parent | |
website (anyOf 1) | string | Alternative | |
website (anyOf 2) | null | Alternative |
Referenced models: Fetch a vendor agreement — response body — payee owners item, Fetch a vendor agreement — response body — payee business vendor uuid, vendor tracking category option id, Fetch a vendor agreement — response body — payee available actions, Fetch a vendor agreement — response body — payee card merchants item
Fetch a vendor agreement — response body — payee available actions
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
can_edit | boolean | Required within parent | |
can_view | boolean | Required within parent |
Fetch a vendor agreement — response body — payee business vendor uuid, vendor tracking category option id
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
uuid | string | Required within parent | |
vendor_tracking_category_option_id | JSON | Required within parent | |
vendor_tracking_category_option_id (anyOf 1) | JSON | Alternative | |
vendor_tracking_category_option_id (anyOf 1) (anyOf 1) | integer | Alternative | |
vendor_tracking_category_option_id (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
vendor_tracking_category_option_id (anyOf 2) | null | Alternative |
Fetch a vendor agreement — response body — payee card merchants item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
merchant_name | string | Required within parent | |
uuid | string | Required within parent |
Fetch a vendor agreement — response body — payee owners item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
department | JSON | Required within parent | |
department (anyOf 1) | string | Alternative | |
department (anyOf 2) | null | Alternative | |
email | string | Required within parent | |
full_name | string | Required within parent | |
id | string | Required within parent | |
is_inactive | boolean | Required within parent | |
is_terminated | boolean | Required within parent | |
location | JSON | Required within parent | |
location (anyOf 1) | string | Alternative | |
location (anyOf 2) | null | Alternative | |
profile_picture_url | JSON | Required within parent | |
profile_picture_url (anyOf 1) | string | Alternative | |
profile_picture_url (anyOf 2) | null | Alternative |
Fetch a vendor agreement — response body — pending spend requests item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
approval_chain_metadata | Model | Required within parent | Expand Fetch a vendor agreement — response body — pending spend requests item approval chain metadata |
can_view | boolean | Required within parent | Whether the current user has permission to view this spend request. |
created_at | string | Required within parent | Format: date-time |
created_by | string | Required within parent | Format: uuid |
currency | string | Required within parent | Currency code for the spend request amounts. |
display_name | JSON | Required within parent | |
display_name (anyOf 1) | string | Alternative | Display name of the spend request. Default: null |
display_name (anyOf 2) | null | Alternative | |
id | string | Required within parent | Format: uuid |
name | JSON | Required within parent | |
name (anyOf 1) | string | Alternative | Name of the spend request. Default: null |
name (anyOf 2) | null | Alternative | |
request_status | string | Required within parent | Known values: APPROVED, DRAFT, REJECTED, SUBMITTED |
source | string | Required within parent | Known values: EXPANSION_REQUEST, RENEWAL, REQUEST_APPROVAL, REQUEST_LINKED_TO_AGREEMENT |
spend_intent_name | JSON | Required within parent | |
spend_intent_name (anyOf 1) | string | Alternative | Name of the associated spend intent. Default: null |
spend_intent_name (anyOf 2) | null | Alternative | |
submitted_at | JSON | Optional | |
submitted_at (anyOf 1) | string | Alternative | Format: date-time |
submitted_at (anyOf 2) | null | Alternative | |
total_amount | JSON | Optional | |
total_amount (anyOf 1) | Model | Alternative | Expand Hold Bill — response body — amount |
total_amount (anyOf 2) | null | Alternative | |
unified_request_id | string | Required within parent | Format: uuid |
user_full_name | string | Required within parent | Full name of the user who created the spend request. |
Referenced models: Fetch a vendor agreement — response body — pending spend requests item approval chain metadata, Hold Bill — response body — amount
Fetch a vendor agreement — response body — pending spend requests item approval chain metadata
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
allow_self_approvals | JSON | Optional | |
allow_self_approvals (anyOf 1) | boolean | Alternative | Default: null |
allow_self_approvals (anyOf 2) | null | Alternative | |
approval_reminder_cooldown | JSON | Optional | |
approval_reminder_cooldown (anyOf 1) | Model | Alternative | Expand Fetch a vendor agreement — response body — pending spend requests item approval chain metadata approval reminder cooldown can send reminder, period in days, reminder communication last sent at Default: null |
approval_reminder_cooldown (anyOf 2) | null | Alternative | |
approval_reminder_limit_reached | boolean | Required within parent | Whether the Bill Pay approval reminder limit has been reached; false for other products. |
approvals_paused | JSON | Optional | |
approvals_paused (anyOf 1) | boolean | Alternative | Default: null |
approvals_paused (anyOf 2) | null | Alternative | |
approvals_paused_by | JSON | Optional | |
approvals_paused_by (anyOf 1) | Model | Alternative | Expand Fetch a vendor agreement — response body — pending spend requests item approval chain metadata approvals paused by deleted at, email, first name, id, last name, lifecycle status, profile picture url, role Default: null |
approvals_paused_by (anyOf 2) | null | Alternative | |
can_add_steps | JSON | Optional | |
can_add_steps (anyOf 1) | boolean | Alternative | Default: null |
can_add_steps (anyOf 2) | null | Alternative | |
can_skip | JSON | Optional | |
can_skip (anyOf 1) | boolean | Alternative | Default: null |
can_skip (anyOf 2) | null | Alternative | |
current_step_in_chain | JSON | Required within parent | |
current_step_in_chain (anyOf 1) | JSON | Alternative | |
current_step_in_chain (anyOf 1) (anyOf 1) | integer | Alternative | |
current_step_in_chain (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
current_step_in_chain (anyOf 2) | null | Alternative | |
has_blocking_approval_requirements | JSON | Optional | |
has_blocking_approval_requirements (anyOf 1) | boolean | Alternative | Default: null |
has_blocking_approval_requirements (anyOf 2) | null | Alternative | |
is_last_step_for_user | boolean | Required within parent | |
is_pausable | JSON | Optional | |
is_pausable (anyOf 1) | boolean | Alternative | Default: null |
is_pausable (anyOf 2) | null | Alternative | |
last_action_date | JSON | Required within parent | |
last_action_date (anyOf 1) | string | Alternative | |
last_action_date (anyOf 2) | null | Alternative | |
needs_user_action | boolean | Required within parent | |
next_approvers | array | Required within parent | |
next_approvers[] | Model | Each item | Expand Fetch a vendor agreement — response body — pending spend requests item approval chain metadata next approvers item |
number_of_approvals | JSON | Required within parent | |
number_of_approvals (anyOf 1) | integer | Alternative | |
number_of_approvals (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
rejection_note | JSON | Optional | |
rejection_note (anyOf 1) | string | Alternative | Default: null |
rejection_note (anyOf 2) | null | Alternative | |
status | string | Required within parent | Known values: APPROVED, INITIALIZED, PENDING, REJECTED, TERMINATED |
total_number_of_approvals | JSON | Required within parent | |
total_number_of_approvals (anyOf 1) | integer | Alternative | |
total_number_of_approvals (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
total_steps_in_chain | JSON | Required within parent | |
total_steps_in_chain (anyOf 1) | integer | Alternative | |
total_steps_in_chain (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Referenced models: Fetch a vendor agreement — response body — pending spend requests item approval chain metadata next approvers item, Fetch a vendor agreement — response body — pending spend requests item approval chain metadata approvals paused by deleted at, email, first name, id, last name, lifecycle status, profile picture url, role, Fetch a vendor agreement — response body — pending spend requests item approval chain metadata approval reminder cooldown can send reminder, period in days, reminder communication last sent at
Fetch a vendor agreement — response body — pending spend requests item approval chain metadata approval reminder cooldown can send reminder, period in days, reminder communication last sent at
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
can_send_reminder | boolean | Required within parent | |
period_in_days | JSON | Required within parent | |
period_in_days (anyOf 1) | integer | Alternative | |
period_in_days (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
reminder_communication_last_sent_at | string | Required within parent |
Fetch a vendor agreement — response body — pending spend requests item approval chain metadata approvals paused by deleted at, email, first name, id, last name, lifecycle status, profile picture url, role
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
deleted_at | JSON | Required within parent | |
deleted_at (anyOf 1) | string | Alternative | |
deleted_at (anyOf 2) | null | Alternative | |
email | string | Required within parent | |
first_name | string | Required within parent | |
id | string | Required within parent | |
last_name | string | Required within parent | |
lifecycle_status | JSON | Optional | |
lifecycle_status (anyOf 1) | string | Alternative | Represents the lifecycle stage that a user is in. Draft: User record exists but cannot accept invites or take any actions. Pending: User has not yet accepted their invite or is marked as preloaded. Active: User has accepted their invite and has access to Ramp. Inactive: The user has been deactivated. Deleted: The user has been soft-deleted. Known values: ACTIVE, DELETED, DRAFT, INACTIVE, PENDING Default: null |
lifecycle_status (anyOf 2) | null | Alternative | |
profile_picture_url | JSON | Required within parent | |
profile_picture_url (anyOf 1) | string | Alternative | |
profile_picture_url (anyOf 2) | null | Alternative | |
role | string | Required within parent | Known values: ADVISOR_CONSOLE_ADMIN, ADVISOR_CONSOLE_USER, AUDITOR, BUSINESS_ADMIN, BUSINESS_BOOKKEEPER, BUSINESS_OWNER, BUSINESS_USER, DEVELOPER_ADMIN, GUEST_USER, IT_ADMIN, MACHINE_USER, PRESALES_DEMO_USER, UNBUNDLED_ADMIN, UNBUNDLED_BOOKKEEPER, UNBUNDLED_OWNER, UNBUNDLED_USER, VENDOR_NETWORK_ADMIN |
Fetch a vendor agreement — response body — pending spend requests item approval chain metadata next approvers item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
approval_trigger_instance_error_message | JSON | Required within parent | |
approval_trigger_instance_error_message (anyOf 1) | string | Alternative | |
approval_trigger_instance_error_message (anyOf 2) | null | Alternative | |
approval_trigger_instance_error_redirect_url | JSON | Required within parent | |
approval_trigger_instance_error_redirect_url (anyOf 1) | string | Alternative | |
approval_trigger_instance_error_redirect_url (anyOf 2) | null | Alternative | |
approval_trigger_type | JSON | Required within parent | |
approval_trigger_type (anyOf 1) | string | Alternative | Known values: GLOBAL_FORM_RESPONSE, IRONCLAD_WORKFLOW_GATE, LAUNCH_ESIGN_WORKFLOW, LAUNCH_EXTERNAL_APPROVAL, LAUNCH_IRONCLAD_WORKFLOW, LAUNCH_THIRD_PARTY_RISK_MANAGEMENT_VENDOR_REVIEW_WORKFLOW, LAUNCH_TICKETING_WORKFLOW, LAUNCH_VENDOR_ONBOARDING, SEND_BACK, WAIT_FOR_BOOKING_COMPLETION |
approval_trigger_type (anyOf 2) | null | Alternative | |
assigned_user_full_name | string | Required within parent | |
assigned_user_id | JSON | Required within parent | |
assigned_user_id (anyOf 1) | string | Alternative | |
assigned_user_id (anyOf 2) | null | Alternative | |
can_create_esign_envelope | JSON | Optional | |
can_create_esign_envelope (anyOf 1) | boolean | Alternative | Whether the current viewer has a pending e-sign assignment for this trigger. Null when eligibility has not been loaded or the trigger is not e-sign. Default: null |
can_create_esign_envelope (anyOf 2) | null | Alternative | |
delegator_user_full_name | JSON | Required within parent | |
delegator_user_full_name (anyOf 1) | string | Alternative | |
delegator_user_full_name (anyOf 2) | null | Alternative | |
delegator_user_id | JSON | Required within parent | |
delegator_user_id (anyOf 1) | string | Alternative | |
delegator_user_id (anyOf 2) | null | Alternative | |
entity_full_name | string | Required within parent | |
entity_id | JSON | Required within parent | |
entity_id (anyOf 1) | string | Alternative | |
entity_id (anyOf 2) | null | Alternative | |
entity_type | string | Required within parent | Known values: ANY_ADMIN, GROUP, MANAGER, TRIGGER, USER, VENDOR_OWNER, VENDOR_OWNER_MANAGER |
external_url | JSON | Required within parent | |
external_url (anyOf 1) | string | Alternative | |
external_url (anyOf 2) | null | Alternative | |
notes | JSON | Required within parent | |
notes (anyOf 1) | string | Alternative | |
notes (anyOf 2) | null | Alternative | |
provider_type | JSON | Optional | |
provider_type (anyOf 1) | string | Alternative | Default: null |
provider_type (anyOf 2) | null | Alternative |
Fetch a vendor agreement — response body — purchase orders item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
can_view | boolean | Required within parent | Whether the current user has permission to view this purchase order. |
documents | array | Required within parent | |
documents[] | object | Each item | |
end_date | JSON | Required within parent | |
end_date (anyOf 1) | string | Alternative | End date of the purchase order. Default: null Format: date |
end_date (anyOf 2) | null | Alternative | |
id | string | Required within parent | Unique identifier for the purchase order. |
name | JSON | Required within parent | |
name (anyOf 1) | string | Alternative | Name of the purchase order. Default: null |
name (anyOf 2) | null | Alternative | |
paid_by_bill_amount | Model | Required within parent | Expand Hold Bill — response body — amount |
paid_by_card_amount | Model | Required within parent | Expand Hold Bill — response body — amount |
pending_bill_amount | Model | Required within parent | Expand Hold Bill — response body — amount |
purchase_order_number | JSON | Required within parent | |
purchase_order_number (anyOf 1) | string | Alternative | External purchase order number. Default: null |
purchase_order_number (anyOf 2) | null | Alternative | |
spend_request | Model | Required within parent | Expand Fetch a vendor agreement — response body — purchase orders item spend request |
start_date | JSON | Required within parent | |
start_date (anyOf 1) | string | Alternative | Start date of the purchase order. Default: null Format: date |
start_date (anyOf 2) | null | Alternative | |
status | JSON | Optional | |
status (anyOf 1) | string | Alternative | Known values: CLOSED, DELETED, FULLY_BILLED, OPEN, PARTIALLY_BILLED |
status (anyOf 2) | null | Alternative | |
total_amount | Model | Required within parent | Expand Hold Bill — response body — amount |
Referenced models: Fetch a vendor agreement — response body — purchase orders item spend request, Hold Bill — response body — amount
Fetch a vendor agreement — response body — purchase orders item spend request
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
approved_at | JSON | Required within parent | |
approved_at (anyOf 1) | string | Alternative | Date when the spend request was approved. Default: null Format: date |
approved_at (anyOf 2) | null | Alternative | |
currency | string | Required within parent | Currency code for the spend request amounts. |
id | string | Required within parent | Format: uuid |
name | JSON | Required within parent | |
name (anyOf 1) | string | Alternative | Name of the spend request. Default: null |
name (anyOf 2) | null | Alternative | |
source | string | Required within parent | Known values: EXPANSION_REQUEST, RENEWAL, REQUEST_APPROVAL, REQUEST_LINKED_TO_AGREEMENT |
submitted_at | JSON | Optional | |
submitted_at (anyOf 1) | string | Alternative | Format: date-time |
submitted_at (anyOf 2) | null | Alternative | |
total_amount | JSON | Optional | |
total_amount (anyOf 1) | Model | Alternative | Expand Hold Bill — response body — amount |
total_amount (anyOf 2) | null | Alternative | |
unified_request_id | string | Required within parent | Format: uuid |
user_full_name | string | Required within parent | Full name of the user who created the spend request. |
Referenced models: Hold Bill — response body — amount
Fetch a vendor bank account — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
account_nickname | string | Optional | Nickname of the vendor bank account. |
account_number_last_four | JSON | Required within parent | |
account_number_last_four (anyOf 1) | string | Alternative | Last four digits of the bank account number. Read only: true |
account_number_last_four (anyOf 2) | null | Alternative | |
currency | string | Required within parent | Currency of the vendor bank account. Known values: AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BOV, BRL, BSD, BTN, BWP, BYN, BZD, CAD, CDF, CHE, CHF, CHW, CLF, CLP, CNH, CNY, COP, COU, CRC, CUC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, EUR, EURC, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, IRR, ISK, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRU, MUR, MVR, MWK, MXN, MXV, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, OPEN_USD, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLE, SLL, SOS, SRD, SSP, STN, SVC, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, USDB, USDC, USDG, USDT, USN, UYI, UYU, UYW, UZS, VED, VES, VND, VUV, WST, XAD, XAF, XAG, XAU, XBA, XBB, XBC, XBD, XCD, XCG, XDR, XOF, XPD, XPF, XPT, XSU, XTS, XUA, XXX, YER, ZAR, ZMW, ZWG, ZWL |
id | string | Required within parent | Unique identifier of the vendor bank account. Format: uuid |
is_default | boolean | Required within parent | Whether this is the payee's default bank account. For a pending account, whether its vendor edit makes it the default. Read only: true |
payment_method | string | Required within parent | Supported payment method for the vendor bank account. Known values: ACH, AUTOMATIC_CARD_PAYMENT, CARD, CHECK, CRYPTO_WALLET_TRANSFER, DIRECT_DEBIT, DOMESTIC_WIRE, EARLY_PAYMENT_DISCOUNT, FED_NOW, INTERNATIONAL, LOCAL_BANK_TRANSFER, ONE_TIME_CARD, ONE_TIME_CARD_DELIVERY, PAID_MANUALLY, RTP, SWIFT, UNSPECIFIED, VENDOR_CREDIT |
proposal_id | JSON | Required within parent | |
proposal_id (anyOf 1) | string | Alternative | Current approval proposal for the vendor edit that adds this bank account. Further changes submitted to the same pending edit replace it, so it may differ from the proposal_id returned on submission. Null unless status is pending_approval. Format: uuid Read only: true |
proposal_id (anyOf 2) | null | Alternative | |
status | string | Required within parent | Approval status of the vendor bank account. Known values: active, pending_approval, pending_deletion Read only: true |
Fetch a vendor contact — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
email | JSON | Required within parent | |
email (anyOf 1) | string | Alternative | |
email (anyOf 2) | null | Alternative | |
first_name | JSON | Required within parent | |
first_name (anyOf 1) | string | Alternative | |
first_name (anyOf 2) | null | Alternative | |
id | string | Required within parent | Unique identifier of the vendor contact. Format: uuid |
is_default | boolean | Required within parent | |
last_name | JSON | Required within parent | |
last_name (anyOf 1) | string | Alternative | |
last_name (anyOf 2) | null | Alternative | |
phone | JSON | Required within parent | |
phone (anyOf 1) | string | Alternative | |
phone (anyOf 2) | null | Alternative |
Fetch a vendor credit — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
accounting_date | string | Required within parent | Accounting date of the vendor credit Format: date |
accounting_field_selections | array | Required within parent | List of accounting field selections associated with this vendor credit Read only: true |
accounting_field_selections[] | Model | Each item | Expand Hold Bill — response body — accounting field selections item |
applied_bills | array | Required within parent | Bills that this Vendor Credit has been applied to. A Vendor Credit can be applied to multiple Bills Read only: true |
applied_bills[] | Model | Each item | Expand Fetch a vendor credit — response body — applied bills item |
applied_draft_bills | array | Required within parent | Draft Bills that this Vendor Credit has been applied to. A Vendor Credit can be applied to multiple Draft Bills Read only: true |
applied_draft_bills[] | Model | Each item | Expand Fetch a vendor credit — response body — applied bills item |
archived_at | JSON | Required within parent | |
archived_at (anyOf 1) | string | Alternative | The datetime the vendor credit was archived. Null for active credits. Archived credits cannot be applied to bills, even when remaining_amount is positive. Format: date-time |
archived_at (anyOf 2) | null | Alternative | |
created_at | JSON | Required within parent | |
created_at (anyOf 1) | string | Alternative | Date and time when the vendor credit was created Format: date-time |
created_at (anyOf 2) | null | Alternative | |
entity_id | JSON | Required within parent | |
entity_id (anyOf 1) | string | Alternative | UUID of the business entity associated with this vendor credit Format: uuid |
entity_id (anyOf 2) | null | Alternative | |
expense_line_items | array | Required within parent | Expense line items of the vendor credit. Expense line items contain an overall amount. |
expense_line_items[] | Model | Each item | Expand Fetch a vendor credit — response body — expense line items item |
id | string | Required within parent | Unique identifier for the vendor credit |
inventory_line_items | array | Required within parent | Inventory line items of the vendor credit. Inventory line items are tied to a particular good or service. |
inventory_line_items[] | Model | Each item | Expand Fetch a vendor credit — response body — inventory line items item |
reference_bill_id | JSON | Required within parent | |
reference_bill_id (anyOf 1) | string | Alternative | UUID of the bill that was the origin of this vendor credit, if any Format: uuid |
reference_bill_id (anyOf 2) | null | Alternative | |
reference_number | JSON | Required within parent | |
reference_number (anyOf 1) | string | Alternative | Reference number from the vendor credit memo |
reference_number (anyOf 2) | null | Alternative | |
remaining_amount | Model | Required within parent | Expand Hold Bill — response body — amount Unapplied amount, equal to total_amount minus total_applied_amount. This amount is retained for archived credits and does not indicate eligibility to apply the credit. Credits with a non-null archived_at cannot be applied. Denominated in the Vendor Credit's currency. Read only: true |
total_amount | Model | Required within parent | Expand Hold Bill — response body — amount Total amount of the vendor credit, sum of all line items, in the Vendor Credit's currency. Read only: true |
total_applied_amount | Model | Required within parent | Expand Hold Bill — response body — amount Total amount that has been applied to bills and/or draft bills, in the Vendor Credit's currency. Read only: true |
vendor_id | string | Required within parent | UUID of the payee associated with this vendor credit Format: uuid |
Referenced models: Hold Bill — response body — accounting field selections item, Hold Bill — response body — amount, Fetch a vendor credit — response body — applied bills item, Fetch a vendor credit — response body — expense line items item, Fetch a vendor credit — response body — inventory line items item
Fetch a vendor credit — response body — applied bills item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
amount | Model | Required within parent | Expand Hold Bill — response body — amount Amount of this Vendor Credit that has been applied to the given bill, in the Vendor Credit's currency. Read only: true |
bill_id | string | Required within parent | UUID of the bill or draft bill that this vendor credit is applied to Format: uuid Read only: true |
Referenced models: Hold Bill — response body — amount
Fetch a vendor credit — response body — expense line items item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
accounting_field_selections | array | Required within parent | List of accounting field options selected to code the line item. |
accounting_field_selections[] | Model | Each item | Expand Hold Bill — response body — accounting field selections item |
amount | Model | Required within parent | Expand Hold Bill — response body — amount Amount of the line item, in the Vendor Credit's currency. Read only: true |
memo | string | Optional | Memo of the line item |
Referenced models: Hold Bill — response body — accounting field selections item, Hold Bill — response body — amount
Fetch a vendor credit — response body — inventory line items item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
accounting_field_selections | array | Required within parent | List of accounting field options selected to code the line item. |
accounting_field_selections[] | Model | Each item | Expand Hold Bill — response body — accounting field selections item |
amount | Model | Required within parent | Expand Hold Bill — response body — amount Amount of the line item, equal to the product of unit quantity and unit price, in the Vendor Credit's currency. Read only: true |
memo | string | Optional | Memo of the line item |
unit_price | Model | Required within parent | Expand Hold Bill — response body — amount Unit price of the line item, in the Vendor Credit's currency. Read only: true |
unit_quantity | JSON | Required within parent | |
unit_quantity (anyOf 1) | number | Alternative | Unit quantity of the line item |
unit_quantity (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Referenced models: Hold Bill — response body — accounting field selections item, Hold Bill — response body — amount
Fetch a vendor — vendor get Vendor Resource — 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 |
approval_status | string | Required within parent | Approval status of the vendor. Known values: APPROVED, PENDING, REJECTED |
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 |
custom_form_collection_response | JSON | Required within parent | |
custom_form_collection_response (anyOf 1) | Model | Alternative | Expand Fetch a custom form collection response by ID — response body — custom form collection response Custom form collection with an associated response log entry. Read only: true |
custom_form_collection_response (anyOf 2) | null | Alternative | |
custom_record_fields | JSON | Required within parent | |
custom_record_fields (anyOf 1) | array | Alternative | Read only: true |
custom_record_fields (anyOf 1)[] | Model | Each item | Expand Get a business entity — response body — custom record fields item |
custom_record_fields (anyOf 2) | null | Alternative | |
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, Fetch a custom form collection response by ID — response body — custom form collection response, Hold Bill — response body — amount, Get a business entity — response body — custom record fields item, Create a new vendor — response body — default payment method policy, update source
Link a spend request to a vendor agreement — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
source | string | Required within parent | Type of agreement relationship to create for the spend request. Supported values are RENEWAL and EXPANSION_REQUEST. One of: EXPANSION_REQUEST, RENEWAL |
spend_request_id | string | Required within parent | Unique identifier of the spend request to link to the agreement. Format: uuid |
Link a spend request to a vendor agreement — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
agreement | Model | Required within parent | Expand Fetch a vendor agreement — response body |
number_of_documents_linked | JSON | Required within parent | |
number_of_documents_linked (anyOf 1) | integer | Alternative | Number of documents linked to the agreement. |
number_of_documents_linked (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
number_of_purchase_orders_linked | JSON | Required within parent | |
number_of_purchase_orders_linked (anyOf 1) | integer | Alternative | Number of purchase orders linked to the agreement. |
number_of_purchase_orders_linked (anyOf 2) | string | Alternative | Pattern: ^-?[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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
documents | array | Optional | Existing documents to link to the agreement. |
documents[] | Model | Each item | Expand Link purchase orders or documents to a vendor agreement — request body — body documents item |
purchase_order_ids | array | Optional | Unique identifiers of purchase orders to link to the agreement. |
purchase_order_ids[] | string | Each item |
Referenced models: Link purchase orders or documents to a vendor agreement — request body — body documents item
Link purchase orders or documents to a vendor agreement — request body — body documents item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | discriminator: {"mapping": {"CUSTOM_FORM_FILE": "#/components/schemas/ApiVendorAgreementCustomFormFileLinkInputRequestBody", "PAYEE_DOCUMENT": "#/components/schemas/ApiVendorAgreementPayeeDocumentLinkInputRequestBody", "SPEND_REQUEST_DOCUMENT": "#/components/schemas/ApiVendorAgreementSpendRequestDocumentLinkInputRequestBody"}, "propertyName": "type"} |
$ (oneOf 1) | Model | Alternative | Expand Link purchase orders or documents to a vendor agreement — request body — body documents item type CUSTOM FORM FILE |
$ (oneOf 2) | Model | Alternative | Expand Link purchase orders or documents to a vendor agreement — request body — body documents item type PAYEE DOCUMENT |
$ (oneOf 3) | Model | Alternative | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
id | string | Required within parent | Unique identifier of the document or file to link. Format: uuid |
type | string | Optional | Document source type. Must equal: CUSTOM_FORM_FILE |
Link purchase orders or documents to a vendor agreement — request body — body documents item type PAYEE DOCUMENT
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
id | string | Required within parent | Unique identifier of the document or file to link. Format: uuid |
type | string | Optional | Document source type. Must equal: PAYEE_DOCUMENT |
Link purchase orders or documents to a vendor agreement — request body — body documents item type SPEND REQUEST DOCUMENT
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
id | string | Required within parent | Unique identifier of the document or file to link. Format: uuid |
type | string | Optional | Document source type. Must equal: SPEND_REQUEST_DOCUMENT |
List available payment methods for a 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 List available payment methods for a vendor — 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 available payment methods for a vendor — response body — data item
List available payment methods for a vendor — response body — data item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | discriminator: {"mapping": {"ACH": "#/components/schemas/ApiVendorAchPaymentMethodResource", "CHECK": "#/components/schemas/ApiVendorCheckPaymentMethodResource"}, "propertyName": "type"} |
$ (anyOf 1) | Model | Alternative | Expand List available payment methods for a vendor — response body — data item type ACH |
$ (anyOf 2) | Model | Alternative | Expand List available payment methods for a vendor — response body — data item type CHECK |
Referenced models: List available payment methods for a vendor — response body — data item type ACH, List available payment methods for a vendor — response body — data item type CHECK
List available payment methods for a vendor — response body — data item type ACH
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
account_number_last_four | string | Required within parent | Last four digits of the bank account number. Maximum length: 4 Minimum length: 4 |
fee | Model | Required within parent | Expand Hold Bill — response body — amount The fee charged for using this payment method. |
id | string | Required within parent | Unique identifier of the payment method. Format: uuid |
routing_number_last_four | string | Required within parent | Last four digits of the routing number. Maximum length: 4 Minimum length: 4 |
type | string | Required within parent | The type of payment method. Must equal: ACH |
Referenced models: Hold Bill — response body — amount
List available payment methods for a vendor — response body — data item type CHECK
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
fee | Model | Required within parent | Expand Hold Bill — response body — amount The fee charged for using this payment method. |
id | string | Required within parent | Unique identifier of the payment method. Format: uuid |
mailing_address | Model | Required within parent | Expand List available payment methods for a vendor — response body — data item type CHECK mailing address The mailing address for check delivery. |
type | string | Required within parent | The type of payment method. Must equal: CHECK |
Referenced models: List available payment methods for a vendor — response body — data item type CHECK mailing address, Hold Bill — response body — amount
List available payment methods for a vendor — response body — data item type CHECK mailing address
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
address_line_1 | string | Required within parent | Primary address line. |
address_line_2 | JSON | Required within parent | |
address_line_2 (anyOf 1) | string | Alternative | Secondary address line. Default: null |
address_line_2 (anyOf 2) | null | Alternative | |
city | string | Required within parent | City name. |
country | string | Required within parent | Two-letter ISO 3166-1 country code. |
postal_code | string | Required within parent | Postal or ZIP code. |
state | JSON | Required within parent | |
state (anyOf 1) | string | Alternative | State or province abbreviation. Default: null Maximum length: 2 Minimum length: 2 |
state (anyOf 2) | null | Alternative |