Skip to content

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

FieldTypePresenceDescription and constraints
$objectRoot
account_nicknamestringOptionalOptional nickname for the payment account
ach_detailsModelOptionalExpand Add to a vendor's bank account details — request body — body ach details
ACH payment details
crypto_detailsModelOptionalExpand Add to a vendor's bank account details — request body — body crypto details
Crypto wallet (stablecoin) payout details
is_defaultbooleanOptionalWhether this should be the default payment method
Default: false
wire_detailsModelOptionalExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
account_namestringOptionalAccount name
Default: Checking Account
account_numberstringRequired within parentACH account number
account_owner_typestringOptionalAccount owner type
Default: BUSINESS
One of: BUSINESS, INDIVIDUAL
account_typestringOptionalAccount type
Default: Checking
One of: Checking, Savings
routing_numberstringRequired within parentACH routing number

Add to a vendor's bank account details — request body — body crypto details

FieldTypePresenceDescription and constraints
$objectRoot
account_nameJSONOptional
account_name (anyOf 1)stringAlternativeName of the wallet's account holder.
Default: null
account_name (anyOf 2)nullAlternative
networkstringRequired within parentBlockchain 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_addressstringRequired within parentDestination crypto wallet address.

Add to a vendor's bank account details — request body — body wire details

FieldTypePresenceDescription and constraints
$objectRoot
account_namestringOptionalAccount holder name. If omitted, the account is labeled Checking Account and any saved beneficiary address uses the vendor name.
account_numberstringRequired within parentWire account number
beneficiary_addressModelOptionalExpand 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_numberstringRequired within parentWire 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

FieldTypePresenceDescription and constraints
$objectRoot
address_line_1stringRequired within parentPrimary address line of the vendor.
address_line_2JSONOptional
address_line_2 (anyOf 1)stringAlternativeSecondary address line or suite number of the vendor.
address_line_2 (anyOf 2)nullAlternative
citystringRequired within parentCity of the recipient address.
Pattern: \S
countrystringRequired within parentTwo-letter ISO 3166-1 country code of the recipient address.
postal_codestringRequired within parentPostal or ZIP code of the recipient address.
Pattern: \S
stateJSONOptional
state (anyOf 1)stringAlternativeAddress 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)nullAlternative

Add to a vendor's bank account details — response body

FieldTypePresenceDescription and constraints
$objectRoot
payment_method_idJSONOptional
payment_method_id (anyOf 1)stringAlternativeUnique identifier of the created payment method. Null when the update requires approval (status is pending_approval).
Format: uuid
payment_method_id (anyOf 2)nullAlternative
payment_method_typeJSONOptional
payment_method_type (anyOf 1)stringAlternativeType 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)nullAlternative
proposal_idJSONOptional
proposal_id (anyOf 1)stringAlternativeUnique identifier of the approval proposal, if approval is required.
Format: uuid
proposal_id (anyOf 2)nullAlternative
statusstringRequired within parentStatus of the bank account update operation.
Known values: approved, pending_approval
vendor_idstringRequired within parentUnique identifier of the vendor.
Format: uuid

Archive a vendor bank account — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
replacement_bank_account_idJSONOptional
replacement_bank_account_id (anyOf 1)stringAlternativeIf 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)nullAlternative

Create a new vendor — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
accounting_vendor_remote_idstringOptionalThe 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_idJSONOptional
acting_user_id (anyOf 1)stringAlternativeDeprecated 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)nullAlternative
addressModelOptionalExpand Create a new vendor — request body — body address
The address of the vendor.
business_vendor_contactsModelRequired within parentExpand Create a new vendor — request body — body business vendor contacts
Detailed information about the vendor contact.
countryJSONOptional
country (anyOf 1)stringAlternativeThe country of the vendor. Defaults to US when omitted or null.
country (anyOf 2)nullAlternative
default_entity_idJSONOptional
default_entity_id (anyOf 1)stringAlternativeUnique 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)nullAlternative
external_vendor_idJSONOptional
external_vendor_id (anyOf 1)stringAlternativeCustomer-defined external identifier for the vendor. This is independent of accounting system remote IDs.
Default: null
external_vendor_id (anyOf 2)nullAlternative
namestringOptionalName of the new vendor to be created.
Minimum length: 1
net_payment_termsJSONOptional
net_payment_terms (anyOf 1)integerAlternativeNumber 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)nullAlternative
parent_vendor_idJSONOptional
parent_vendor_id (anyOf 1)stringAlternativeUnique identifier of the parent vendor to associate with this vendor.
Default: null
Format: uuid
parent_vendor_id (anyOf 2)nullAlternative
request_payment_detailsbooleanOptionalWhether 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_detailsbooleanOptionalWhether to request tax information from the vendor (Tax Identification Number, federal tax classification, and tax address). Requires a contact email.
Default: false
requesting_user_idJSONOptional
requesting_user_id (anyOf 1)stringAlternativeUnique 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)nullAlternative
stateJSONOptional
state (anyOf 1)stringAlternativeOptional vendor-level two-letter US state abbreviation, such as VA. Ignored for non-US vendor countries.
Default: null
state (anyOf 2)nullAlternative
vendor_owner_idJSONOptional
vendor_owner_id (anyOf 1)stringAlternativeUnique 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)nullAlternative
vendor_tracking_category_option_idstringOptionalRamp 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

FieldTypePresenceDescription and constraints
$objectRoot
address_line_1stringRequired within parentPrimary address line of the vendor.
address_line_2JSONOptional
address_line_2 (anyOf 1)stringAlternativeSecondary address line or suite number of the vendor.
address_line_2 (anyOf 2)nullAlternative
citystringRequired within parentCity of the vendor address.
countrystringRequired within parentCountry of the vendor address.
pay_to_nameJSONOptional
pay_to_name (anyOf 1)stringAlternativeRecipient name printed on checks mailed to this address. Defaults to the vendor name.
Pattern: \s*\S
pay_to_name (anyOf 2)nullAlternative
postal_codestringRequired within parentPostal or ZIP code of the vendor address.
stateJSONOptional
state (anyOf 1)stringAlternativeAddress 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)nullAlternative

Create a new vendor — request body — body business vendor contacts

FieldTypePresenceDescription and constraints
$objectRoot
emailstringRequired within parent
first_namestringOptional
last_namestringOptional
phonestringOptional

Create a new vendor — response body

FieldTypePresenceDescription and constraints
$objectRoot
accounting_vendor_remote_idJSONRequired within parent
accounting_vendor_remote_id (anyOf 1)stringAlternativeThe accounting remote id of the vendor.
accounting_vendor_remote_id (anyOf 2)nullAlternative
addressModelOptionalExpand Create a new vendor — response body — address
The default address of the vendor.
addressesarrayRequired within parentThe addresses of the vendor.
addresses[]ModelEach itemExpand Create a new vendor — response body — addresses item
billing_frequencystringOptionalThe billing frequency for this vendor.
Known values: ANNUAL, MONTHLY, MULTIPLE, NA, OTHER, QUARTERLY, ROLLING, TBD, TWICE_A_YEAR
contactsarrayRequired within parentUnique identifiers of contacts associated with this vendor.
contacts[]stringEach itemUnique identifier of the vendor contact.
Format: uuid
countrystringRequired within parentThe 2-letter country of the vendor.
created_atstringRequired within parentThe date and time when this vendor was created.
Format: date-time
default_entity_idJSONRequired within parent
default_entity_id (anyOf 1)stringAlternativeUnique identifier of the default business entity associated with this vendor.
Format: uuid
default_entity_id (anyOf 2)nullAlternative
default_payment_methodJSONRequired within parent
default_payment_method (anyOf 1)ModelAlternativeExpand 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)nullAlternative
descriptionstringOptionalDescription of the vendor.
display_nameJSONRequired within parent
display_name (anyOf 1)stringAlternativeDisplay name of the vendor.
display_name (anyOf 2)nullAlternative
external_vendor_idJSONRequired within parent
external_vendor_id (anyOf 1)stringAlternativeCustomer-defined external identifier for the vendor. This is independent of accounting system remote IDs.
external_vendor_id (anyOf 2)nullAlternative
federal_tax_classificationstringOptionalThe 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
idstringRequired within parentUnique identifier of the vendor.
Format: uuid
is_activebooleanRequired within parentWhether this vendor is active.
is_deletablebooleanRequired within parentWhether this vendor is deletable.
Read only: true
merchant_idstringOptionalThe id of the card merchant.
Format: uuid
namestringRequired within parentName of the vendor.
name_legalstringOptionalLegal name of the vendor.
net_payment_termsJSONOptional
net_payment_terms (anyOf 1)JSONAlternative
net_payment_terms (anyOf 1) (anyOf 1)integerAlternativeNumber of days after receipt that payment is due. 0 means due on receipt.
net_payment_terms (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
net_payment_terms (anyOf 2)nullAlternative
parent_vendor_idJSONRequired within parent
parent_vendor_id (anyOf 1)stringAlternativeUnique identifier of the parent vendor, if this vendor has one.
Format: uuid
Read only: true
parent_vendor_id (anyOf 2)nullAlternative
sk_category_idJSONOptional
sk_category_id (anyOf 1)integerAlternativeRamp 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)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
sk_category_namestringOptionalThe category name of the vendor.
statestringOptional
subsidiaryarrayOptionalERP subsidiary identifiers associated with this vendor. Only returned when `include_subsidiary=true`.
Read only: true
subsidiary[]stringEach item
tax_addressModelOptionalExpand Create a new vendor — response body — address
The tax address of the vendor.
total_spend_all_timeModelRequired within parentExpand Hold Bill — response body — amount
Total spend for all time for this vendor.
Read only: true
total_spend_last_30_daysModelRequired within parentExpand Hold Bill — response body — amount
Total spend for the last 30 days for this vendor.
Read only: true
total_spend_last_365_daysModelRequired within parentExpand Hold Bill — response body — amount
Total spend for the last 365 days for this vendor.
Read only: true
total_spend_ytdModelRequired within parentExpand Hold Bill — response body — amount
Total spend year-to-date for this vendor.
Read only: true
updated_atJSONRequired within parent
updated_at (anyOf 1)stringAlternativeThe date and time when this vendor was last updated.
Format: date-time
updated_at (anyOf 2)nullAlternative
vendor_owner_idJSONRequired within parent
vendor_owner_id (anyOf 1)stringAlternativeUnique identifier of the user which owns this vendor.
Format: uuid
Read only: true
vendor_owner_id (anyOf 2)nullAlternative
vendor_typestringOptionalThe 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

FieldTypePresenceDescription and constraints
$objectRoot
address_line_1stringRequired within parentPrimary address line of the vendor address.
address_line_2stringOptionalSecondary address line of the vendor address.
citystringRequired within parentCity of the vendor address.
countrystringRequired within parentCountry of the vendor address.
postal_codestringRequired within parentPostal or ZIP code of the vendor address.
statestringOptionalState or province of the vendor address.

Create a new vendor — response body — addresses item

FieldTypePresenceDescription and constraints
$objectRoot
address_line_1stringRequired within parentPrimary address line of the vendor address.
address_line_2stringOptionalSecondary address line of the vendor address.
citystringRequired within parentCity of the vendor address.
countrystringRequired within parentCountry of the vendor address.
idstringRequired within parentUnique identifier of the vendor address.
Format: uuid
is_defaultbooleanRequired within parentWhether this is the vendor's default address.
Read only: true
pay_to_namestringRequired within parentRecipient name printed on checks mailed to this address.
postal_codestringRequired within parentPostal or ZIP code of the vendor address.
statestringOptionalState or province of the vendor address.

Create a new vendor — response body — default payment method policy, update source

FieldTypePresenceDescription and constraints
$objectRoot
policyJSONOptional
policy (anyOf 1)ModelAlternativeExpand Create a new vendor — response body — default payment method policy, update source policy value
policy (anyOf 2)nullAlternative
update_sourceJSONOptional
update_source (anyOf 1)stringAlternativeKnown values: AUTO, MANUAL
update_source (anyOf 2)nullAlternative

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

FieldTypePresenceDescription and constraints
$JSONRootdiscriminator: {"mapping": {"ADDRESS": "#/components/schemas/DefaultPaymentMethodAddressPolicy", "BANK_ACCOUNT": "#/components/schemas/DefaultPaymentMethodBankAccountPolicy", "CARD": "#/components/schemas/DefaultPaymentMethodCardPolicy", "DIRECT_DEBIT": "#/components/schemas/DefaultPaymentMethodDirectDebitPolicy"}, "propertyName": "kind"}
$ (anyOf 1)ModelAlternativeExpand Create a new vendor — response body — default payment method policy, update source policy value kind ADDRESS
$ (anyOf 2)ModelAlternativeExpand Create a new vendor — response body — default payment method policy, update source policy value kind BANK ACCOUNT
$ (anyOf 3)ModelAlternativeExpand Create a new vendor — response body — default payment method policy, update source policy value kind CARD
$ (anyOf 4)ModelAlternativeExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand Create a new vendor — response body — address
kindstringRequired within parentMust 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

FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand Create a new vendor — response body — default payment method policy, update source policy value kind BANK ACCOUNT data
kindstringRequired within parentMust 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

FieldTypePresenceDescription and constraints
$objectRoot
account_nicknamestringOptionalNickname of the vendor bank account.
account_number_last_fourJSONRequired within parent
account_number_last_four (anyOf 1)stringAlternativeLast four digits of the bank account number.
Read only: true
account_number_last_four (anyOf 2)nullAlternative
currencystringRequired within parentCurrency 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
idstringRequired within parentUnique identifier of the vendor bank account.
Format: uuid
is_defaultbooleanRequired within parentWhether this is the payee's default bank account. For a pending account, whether its vendor edit makes it the default.
Read only: true
payment_methodstringRequired within parentSupported 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

FieldTypePresenceDescription and constraints
$objectRoot
card_payment_methodstringRequired within parentKnown 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
kindstringRequired within parentMust equal: CARD

Create a new vendor — response body — default payment method policy, update source policy value kind DIRECT DEBIT

FieldTypePresenceDescription and constraints
$objectRoot
kindstringRequired within parentThe vendor's default payment policy type.
Must equal: DIRECT_DEBIT
payment_methodstringRequired within parentThe 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

FieldTypePresenceDescription and constraints
$objectRoot
auto_renewalbooleanRequired within parentWhether the agreement automatically renews.
contract_owner_idsJSONOptional
contract_owner_ids (anyOf 1)arrayAlternativeList of contract owner user IDs.
contract_owner_ids (anyOf 1)[]stringEach itemFormat: uuid
contract_owner_ids (anyOf 2)nullAlternative
descriptionJSONOptional
description (anyOf 1)stringAlternativeDescription of the vendor agreement.
Default: null
description (anyOf 2)nullAlternative
end_dateJSONOptional
end_date (anyOf 1)stringAlternativeEnd date of the agreement.
Default: null
Format: date
end_date (anyOf 2)nullAlternative
last_date_to_terminateJSONOptional
last_date_to_terminate (anyOf 1)stringAlternativeLast date by which the agreement can be terminated.
Default: null
Format: date
last_date_to_terminate (anyOf 2)nullAlternative
line_itemsJSONOptional
line_items (anyOf 1)arrayAlternativeLine items associated with the agreement.
Default: null
line_items (anyOf 1)[]ModelEach itemExpand Create a vendor agreement — request body — body line items Line items associated with the agreement item
line_items (anyOf 2)nullAlternative
namestringRequired within parentName of the vendor agreement.
Minimum length: 1
notifications_onbooleanRequired within parentWhether notifications are enabled for this agreement.
renewal_notification_settingsJSONOptional
renewal_notification_settings (anyOf 1)ModelAlternativeExpand 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)nullAlternative
start_datestringRequired within parentStart date of the agreement.
Format: date
total_valueModelRequired within parentExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
discountJSONOptional
discount (anyOf 1)JSONAlternativeDiscount applied to the line item, if any.
Default: null
discount (anyOf 1) (oneOf 1)numberAlternative
discount (anyOf 1) (oneOf 2)stringAlternative
discount (anyOf 2)nullAlternative
price_per_unitJSONRequired within parentPrice for a single unit in the line item.
price_per_unit (oneOf 1)numberAlternative
price_per_unit (oneOf 2)stringAlternative
product_or_service_namestringRequired within parentName of the product or service covered by the agreement line item.
quantityJSONRequired within parentQuantity of units included in the line item.
quantity (oneOf 1)numberAlternative
quantity (oneOf 2)stringAlternative
termJSONOptional
term (anyOf 1)stringAlternativeFreeform term label for the line item, if applicable.
Default: null
term (anyOf 2)nullAlternative
time_unitJSONOptional
time_unit (anyOf 1)stringAlternativeTime unit associated with the line item, if applicable.
Default: null
time_unit (anyOf 2)nullAlternative
total_priceJSONOptional
total_price (anyOf 1)JSONAlternativeTotal price for the line item, if provided.
Default: null
total_price (anyOf 1) (oneOf 1)numberAlternative
total_price (anyOf 1) (oneOf 2)stringAlternative
total_price (anyOf 2)nullAlternative
unitJSONOptional
unit (anyOf 1)stringAlternativeUnit name for the quantity, if applicable.
Default: null
unit (anyOf 2)nullAlternative

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

FieldTypePresenceDescription and constraints
$objectRootComplete 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_triggersJSONOptional
notification_triggers (anyOf 1)arrayAlternativeDefault: null
notification_triggers (anyOf 1)[]ModelEach itemExpand 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)nullAlternative
recipient_approval_group_uuidsJSONOptional
recipient_approval_group_uuids (anyOf 1)arrayAlternativeDefault: null
recipient_approval_group_uuids (anyOf 1)[]stringEach item
recipient_approval_group_uuids (anyOf 2)nullAlternative
recipient_dynamic_user_group_uuidsJSONOptional
recipient_dynamic_user_group_uuids (anyOf 1)arrayAlternativeDefault: null
recipient_dynamic_user_group_uuids (anyOf 1)[]stringEach item
recipient_dynamic_user_group_uuids (anyOf 2)nullAlternative
recipient_user_uuidsJSONOptional
recipient_user_uuids (anyOf 1)arrayAlternativeDefault: null
recipient_user_uuids (anyOf 1)[]stringEach item
recipient_user_uuids (anyOf 2)nullAlternative
recurring_settingsJSONOptional
recurring_settings (anyOf 1)ModelAlternativeExpand 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)nullAlternative
scheduled_enabledJSONOptional
scheduled_enabled (anyOf 1)booleanAlternativePauses scheduled reminders when false; null preserves the current value.
Default: null
scheduled_enabled (anyOf 2)nullAlternative
should_notify_contract_owner_managersbooleanOptionalDefault: 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

FieldTypePresenceDescription and constraints
$objectRoot
contract_eventstringRequired within parentOne of: CONTRACT_ENDS_OR_RENEWS, CONTRACT_START_DATE, LAST_DATE_TO_TERMINATE
days_beforeintegerRequired 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

FieldTypePresenceDescription and constraints
$objectRootComplete 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_cadenceJSONRequired within parent
recurring_cadence (anyOf 1)stringAlternativeRepeat frequency, required when recurrence is enabled. BIWEEKLY means every two weeks.
One of: BIWEEKLY, DAILY, MONTHLY, WEEKLY, YEARLY
recurring_cadence (anyOf 2)nullAlternative
recurring_enabledbooleanRequired within parentOn/off switch. False with a configured recurrence pauses it; must be false when recurring_start_type is null.
recurring_max_occurrencesJSONRequired within parent
recurring_max_occurrences (anyOf 1)integerAlternativeOptional 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)nullAlternative
recurring_start_eventJSONRequired within parent
recurring_start_event (anyOf 1)stringAlternativeContract 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)nullAlternative
recurring_start_offset_daysJSONRequired within parent
recurring_start_offset_days (anyOf 1)integerAlternativeDays 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)nullAlternative
recurring_start_typeJSONRequired within parent
recurring_start_type (anyOf 1)stringAlternativeAnchor 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)nullAlternative

Create a vendor agreement — request body — body total value

FieldTypePresenceDescription and constraints
$objectRoot
amountintegerRequired within parentMonetary amount in the currency's minor unit.
currency_codeModelOptionalExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
emailstringRequired within parentEmail address.
Format: email
first_nameJSONOptional
first_name (anyOf 1)stringAlternativeFirst name.
Maximum length: 40
first_name (anyOf 2)nullAlternative
is_defaultbooleanOptionalWhether this is the default contact.
Default: false
last_nameJSONOptional
last_name (anyOf 1)stringAlternativeLast name.
Maximum length: 40
last_name (anyOf 2)nullAlternative
phoneJSONOptional
phone (anyOf 1)stringAlternativePhone number.
phone (anyOf 2)nullAlternative

Create a vendor contact — response body

FieldTypePresenceDescription and constraints
$objectRoot
contact_idJSONOptional
contact_id (anyOf 1)stringAlternativeCreated contact ID.
Format: uuid
contact_id (anyOf 2)nullAlternative
proposal_idJSONOptional
proposal_id (anyOf 1)stringAlternativePending approval proposal ID.
Format: uuid
proposal_id (anyOf 2)nullAlternative
statusstringRequired within parentCreation status.
Known values: approved, pending_approval
vendor_idstringRequired within parentVendor ID.
Format: uuid

Fetch a vendor agreement — response body

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

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

Fetch a vendor agreement — response body — available actions

FieldTypePresenceDescription and constraints
$objectRoot
can_actionModelRequired within parentExpand Fetch a vendor agreement — response body — available actions can action
Whether the user may perform lifecycle actions on the agreement.
can_editModelRequired within parentExpand Fetch a vendor agreement — response body — available actions can edit
Whether the agreement may be edited.
deleteModelRequired within parentExpand Fetch a vendor agreement — response body — available actions delete
Whether the agreement may be deleted.
request_expansionModelRequired within parentExpand Fetch a vendor agreement — response body — available actions request expansion
Whether an expansion may be requested for the agreement.
request_renewalModelRequired within parentExpand Fetch a vendor agreement — response body — available actions request renewal
Whether a renewal may be requested for the agreement.
send_reminderJSONRequired within parentWhether a manual contract reminder may be sent.
discriminator: {"mapping": {"allowed": "#/components/schemas/ActionAllowedSchema", "denied": "#/components/schemas/SendManualReminderDeniedSchema"}, "propertyName": "status"}
send_reminder (anyOf 1)ModelAlternativeExpand Fetch a vendor agreement — response body — available actions delete status allowed
send_reminder (anyOf 2)ModelAlternativeExpand Fetch a vendor agreement — response body — available actions send reminder status denied
set_statusModelRequired within parentExpand 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

FieldTypePresenceDescription and constraints
$JSONRootdiscriminator: {"mapping": {"allowed": "#/components/schemas/ActionAllowedSchema", "denied": "#/components/schemas/ActionDeniedSchema_AgreementActionDenialReason_"}, "propertyName": "status"}
$ (anyOf 1)ModelAlternativeExpand Fetch a vendor agreement — response body — available actions delete status allowed
$ (anyOf 2)ModelAlternativeExpand 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

FieldTypePresenceDescription and constraints
$JSONRootdiscriminator: {"mapping": {"allowed": "#/components/schemas/ActionAllowedSchema", "denied": "#/components/schemas/ActionDeniedSchema_EditAgreementDenialReason_"}, "propertyName": "status"}
$ (anyOf 1)ModelAlternativeExpand Fetch a vendor agreement — response body — available actions delete status allowed
$ (anyOf 2)ModelAlternativeExpand 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

FieldTypePresenceDescription and constraints
$JSONRootdiscriminator: {"mapping": {"allowed": "#/components/schemas/ActionAllowedSchema", "denied": "#/components/schemas/ActionDeniedSchema_DeleteRenewalDenialReason_"}, "propertyName": "status"}
$ (anyOf 1)ModelAlternativeExpand Fetch a vendor agreement — response body — available actions delete status allowed
$ (anyOf 2)ModelAlternativeExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
statusstringRequired within parentMust equal: allowed

Fetch a vendor agreement — response body — available actions request expansion

FieldTypePresenceDescription and constraints
$JSONRootdiscriminator: {"mapping": {"allowed": "#/components/schemas/ActionAllowedSchema", "denied": "#/components/schemas/ActionDeniedSchema_RequestExpansionDenialReason_"}, "propertyName": "status"}
$ (anyOf 1)ModelAlternativeExpand Fetch a vendor agreement — response body — available actions delete status allowed
$ (anyOf 2)ModelAlternativeExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
denial_reasonstringRequired within parentWhy the action cannot be performed.
Known values: APPROVED_RENEWAL_REQUEST, MARKED_AS_RENEWED, MARKED_AS_TERMINATED, NO_PERMISSION, PENDING_EXPANSION_REQUEST, PENDING_RENEWAL_REQUEST
statusstringRequired within parentWhether the action can be performed.
Must equal: denied

Fetch a vendor agreement — response body — available actions request renewal

FieldTypePresenceDescription and constraints
$JSONRootdiscriminator: {"mapping": {"allowed": "#/components/schemas/ActionAllowedSchema", "denied": "#/components/schemas/ActionDeniedSchema_RequestRenewalDenialReason_"}, "propertyName": "status"}
$ (anyOf 1)ModelAlternativeExpand Fetch a vendor agreement — response body — available actions delete status allowed
$ (anyOf 2)ModelAlternativeExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
denial_reasonstringRequired within parentWhy 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
statusstringRequired within parentWhether the action can be performed.
Must equal: denied

Fetch a vendor agreement — response body — available actions send reminder status denied

FieldTypePresenceDescription and constraints
$objectRootDenied manual reminder action, with the time the cooldown ends
available_atJSONRequired within parent
available_at (anyOf 1)stringAlternativeWhen 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)nullAlternative
denial_reasonstringRequired within parentWhy the action cannot be performed.
Known values: ARCHIVED, FEATURE_DISABLED, INELIGIBLE_STATUS, IN_COOLDOWN, MISSING_REQUIRED_INFO, NOTIFICATIONS_OFF, NO_PERMISSION, NO_RECIPIENTS, SNOOZED
statusstringRequired within parentWhether the action can be performed.
Must equal: denied

Fetch a vendor agreement — response body — available actions set status

FieldTypePresenceDescription and constraints
$JSONRootdiscriminator: {"mapping": {"allowed": "#/components/schemas/ActionAllowedSchema", "denied": "#/components/schemas/ActionDeniedSchema_SetRenewalStatusDenialReason_"}, "propertyName": "status"}
$ (anyOf 1)ModelAlternativeExpand Fetch a vendor agreement — response body — available actions delete status allowed
$ (anyOf 2)ModelAlternativeExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
denial_reasonstringRequired within parentWhy the action cannot be performed.
Known values: NO_PERMISSION
statusstringRequired within parentWhether 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

FieldTypePresenceDescription and constraints
$objectRoot
denial_reasonstringRequired within parentWhy the action cannot be performed.
Known values: NOT_CONTRACT_OWNER, NOT_VENDOR_OWNER, NO_PERMISSION
statusstringRequired within parentWhether 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

FieldTypePresenceDescription and constraints
$objectRoot
denial_reasonstringRequired within parentWhy the action cannot be performed.
Known values: APPROVED_REQUEST, PENDING_REQUEST, REJECTED_REQUEST
statusstringRequired within parentWhether 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

FieldTypePresenceDescription and constraints
$objectRoot
denial_reasonstringRequired within parentWhy the action cannot be performed.
Known values: APPROVED_RENEWAL_REQUEST, NO_PERMISSION, PENDING_RENEWAL_REQUEST
statusstringRequired within parentWhether the action can be performed.
Must equal: denied

Fetch a vendor agreement — response body — contract owners item

FieldTypePresenceDescription and constraints
$objectRoot
emailstringRequired within parent
first_namestringRequired within parent
full_namestringRequired within parent
idstringRequired within parentFormat: uuid
last_namestringRequired within parent
profile_picture_urlJSONOptional
profile_picture_url (anyOf 1)stringAlternative
profile_picture_url (anyOf 2)nullAlternative

Fetch a vendor agreement — response body — days remaining

FieldTypePresenceDescription and constraints
$objectRoot
end_date_usedJSONOptional
end_date_used (anyOf 1)stringAlternativeKnown values: END_DATE, LAST_DATE_TO_TERMINATE
end_date_used (anyOf 2)nullAlternative
is_expiredJSONOptional
is_expired (anyOf 1)booleanAlternative
is_expired (anyOf 2)nullAlternative
is_overdueJSONOptional
is_overdue (anyOf 1)booleanAlternative
is_overdue (anyOf 2)nullAlternative
num_days_until_endJSONOptional
num_days_until_end (anyOf 1)JSONAlternative
num_days_until_end (anyOf 1) (anyOf 1)integerAlternative
num_days_until_end (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
num_days_until_end (anyOf 2)nullAlternative

Fetch a vendor agreement — response body — draft spend requests item

FieldTypePresenceDescription and constraints
$objectRoot
idstringRequired within parentFormat: uuid
nameJSONOptional
name (anyOf 1)stringAlternative
name (anyOf 2)nullAlternative
sourcestringRequired within parentKnown values: EXPANSION_REQUEST, RENEWAL, REQUEST_APPROVAL, REQUEST_LINKED_TO_AGREEMENT
total_amountJSONOptional
total_amount (anyOf 1)stringAlternative
total_amount (anyOf 2)nullAlternative
unified_request_idstringRequired within parentFormat: uuid
updated_atJSONOptional
updated_at (anyOf 1)stringAlternativeFormat: date
updated_at (anyOf 2)nullAlternative

Fetch a vendor agreement — response body — latest rejected renewal request can view, id, reason, rejected at, unified request id, user full name

FieldTypePresenceDescription and constraints
$objectRoot
can_viewbooleanRequired within parentWhether the current user has permission to view this request.
idstringRequired within parentFormat: uuid
reasonJSONRequired within parent
reason (anyOf 1)stringAlternativeReason provided for rejecting the renewal request.
Default: null
reason (anyOf 2)nullAlternative
rejected_atJSONRequired within parent
rejected_at (anyOf 1)stringAlternativeDate when the renewal request was rejected.
Default: null
Format: date
rejected_at (anyOf 2)nullAlternative
unified_request_idstringRequired within parentFormat: uuid
user_full_namestringRequired within parentFull name of the user who submitted the renewal request.

Fetch a vendor agreement — response body — notification_trigger_group / type: CUSTOM SETTING, DEFAULT BUSINESS SETTING

FieldTypePresenceDescription and constraints
$objectRoot
idstringRequired within parentUnique identifier for the notification trigger group.
notification_triggersarrayRequired within parent
notification_triggers[]ModelEach itemExpand Fetch a vendor agreement — response body — notification_trigger_group / type: CUSTOM SETTING, DEFAULT BUSINESS SETTING notification triggers item
payee_business_settings_idJSONRequired within parent
payee_business_settings_id (anyOf 1)JSONAlternative
payee_business_settings_id (anyOf 1) (anyOf 1)integerAlternativeIdentifier for the associated payee business settings, if any.
Default: null
payee_business_settings_id (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
payee_business_settings_id (anyOf 2)nullAlternative
recipient_approval_groupsarrayRequired within parent
recipient_approval_groups[]ModelEach itemExpand Fetch a vendor agreement — response body — notification_trigger_group / type: CUSTOM SETTING, DEFAULT BUSINESS SETTING recipient approval groups item
recipient_usersarrayRequired within parent
recipient_users[]ModelEach itemExpand Fetch a vendor agreement — response body — notification_trigger_group / type: CUSTOM SETTING, DEFAULT BUSINESS SETTING recipient users item
should_notify_vendor_owner_managerbooleanRequired within parentDeprecated. Always false; vendor owner managers are not notified.
typestringRequired within parentKnown 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

FieldTypePresenceDescription and constraints
$objectRoot
contract_eventstringRequired within parentKnown values: CONTRACT_ENDS_OR_RENEWS, CONTRACT_START_DATE, LAST_DATE_TO_TERMINATE
days_beforeJSONRequired within parent
days_before (anyOf 1)integerAlternativeNumber of days before the contract event to trigger notification.
days_before (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
idstringRequired within parentUnique identifier for the notification trigger.

Fetch a vendor agreement — response body — notification_trigger_group / type: CUSTOM SETTING, DEFAULT BUSINESS SETTING recipient approval groups item

FieldTypePresenceDescription and constraints
$objectRoot
idstringRequired within parentFormat: uuid
membersarrayRequired within parent
members[]ModelEach itemExpand Fetch a vendor agreement — response body — notification_trigger_group / type: CUSTOM SETTING, DEFAULT BUSINESS SETTING recipient approval groups item members item
namestringRequired within parentName 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

FieldTypePresenceDescription and constraints
$objectRoot
memberModelRequired within parentExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
full_namestringRequired within parentFull name of the user.
idstringRequired within parentFormat: uuid

Fetch a vendor agreement — response body — payee

FieldTypePresenceDescription and constraints
$objectRoot
approval_instance_uuidJSONRequired within parent
approval_instance_uuid (anyOf 1)stringAlternative
approval_instance_uuid (anyOf 2)nullAlternative
approval_statusstringRequired within parentKnown values: APPROVED, PENDING, REJECTED
available_actionsModelRequired within parentExpand Fetch a vendor agreement — response body — payee available actions
business_vendorJSONRequired within parent
business_vendor (anyOf 1)ModelAlternativeExpand Fetch a vendor agreement — response body — payee business vendor uuid, vendor tracking category option id
business_vendor (anyOf 2)nullAlternative
card_merchantsarrayRequired within parent
card_merchants[]ModelEach itemExpand Fetch a vendor agreement — response body — payee card merchants item
dba_nameJSONRequired within parent
dba_name (anyOf 1)stringAlternative
dba_name (anyOf 2)nullAlternative
deleted_atJSONRequired within parent
deleted_at (anyOf 1)stringAlternativeFormat: date-time
deleted_at (anyOf 2)nullAlternative
image_urlJSONRequired within parent
image_url (anyOf 1)stringAlternative
image_url (anyOf 2)nullAlternative
is_draftbooleanRequired within parent
namestringRequired within parent
ownersarrayRequired within parent
owners[]ModelEach itemExpand Fetch a vendor agreement — response body — payee owners item
uuidstringRequired within parent
websiteJSONRequired within parent
website (anyOf 1)stringAlternative
website (anyOf 2)nullAlternative

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

FieldTypePresenceDescription and constraints
$objectRoot
can_editbooleanRequired within parent
can_viewbooleanRequired within parent

Fetch a vendor agreement — response body — payee business vendor uuid, vendor tracking category option id

FieldTypePresenceDescription and constraints
$objectRoot
uuidstringRequired within parent
vendor_tracking_category_option_idJSONRequired within parent
vendor_tracking_category_option_id (anyOf 1)JSONAlternative
vendor_tracking_category_option_id (anyOf 1) (anyOf 1)integerAlternative
vendor_tracking_category_option_id (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
vendor_tracking_category_option_id (anyOf 2)nullAlternative

Fetch a vendor agreement — response body — payee card merchants item

FieldTypePresenceDescription and constraints
$objectRoot
merchant_namestringRequired within parent
uuidstringRequired within parent

Fetch a vendor agreement — response body — payee owners item

FieldTypePresenceDescription and constraints
$objectRoot
departmentJSONRequired within parent
department (anyOf 1)stringAlternative
department (anyOf 2)nullAlternative
emailstringRequired within parent
full_namestringRequired within parent
idstringRequired within parent
is_inactivebooleanRequired within parent
is_terminatedbooleanRequired within parent
locationJSONRequired within parent
location (anyOf 1)stringAlternative
location (anyOf 2)nullAlternative
profile_picture_urlJSONRequired within parent
profile_picture_url (anyOf 1)stringAlternative
profile_picture_url (anyOf 2)nullAlternative

Fetch a vendor agreement — response body — pending spend requests item

FieldTypePresenceDescription and constraints
$objectRoot
approval_chain_metadataModelRequired within parentExpand Fetch a vendor agreement — response body — pending spend requests item approval chain metadata
can_viewbooleanRequired within parentWhether the current user has permission to view this spend request.
created_atstringRequired within parentFormat: date-time
created_bystringRequired within parentFormat: uuid
currencystringRequired within parentCurrency code for the spend request amounts.
display_nameJSONRequired within parent
display_name (anyOf 1)stringAlternativeDisplay name of the spend request.
Default: null
display_name (anyOf 2)nullAlternative
idstringRequired within parentFormat: uuid
nameJSONRequired within parent
name (anyOf 1)stringAlternativeName of the spend request.
Default: null
name (anyOf 2)nullAlternative
request_statusstringRequired within parentKnown values: APPROVED, DRAFT, REJECTED, SUBMITTED
sourcestringRequired within parentKnown values: EXPANSION_REQUEST, RENEWAL, REQUEST_APPROVAL, REQUEST_LINKED_TO_AGREEMENT
spend_intent_nameJSONRequired within parent
spend_intent_name (anyOf 1)stringAlternativeName of the associated spend intent.
Default: null
spend_intent_name (anyOf 2)nullAlternative
submitted_atJSONOptional
submitted_at (anyOf 1)stringAlternativeFormat: date-time
submitted_at (anyOf 2)nullAlternative
total_amountJSONOptional
total_amount (anyOf 1)ModelAlternativeExpand Hold Bill — response body — amount
total_amount (anyOf 2)nullAlternative
unified_request_idstringRequired within parentFormat: uuid
user_full_namestringRequired within parentFull 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

FieldTypePresenceDescription and constraints
$objectRoot
allow_self_approvalsJSONOptional
allow_self_approvals (anyOf 1)booleanAlternativeDefault: null
allow_self_approvals (anyOf 2)nullAlternative
approval_reminder_cooldownJSONOptional
approval_reminder_cooldown (anyOf 1)ModelAlternativeExpand 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)nullAlternative
approval_reminder_limit_reachedbooleanRequired within parentWhether the Bill Pay approval reminder limit has been reached; false for other products.
approvals_pausedJSONOptional
approvals_paused (anyOf 1)booleanAlternativeDefault: null
approvals_paused (anyOf 2)nullAlternative
approvals_paused_byJSONOptional
approvals_paused_by (anyOf 1)ModelAlternativeExpand 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)nullAlternative
can_add_stepsJSONOptional
can_add_steps (anyOf 1)booleanAlternativeDefault: null
can_add_steps (anyOf 2)nullAlternative
can_skipJSONOptional
can_skip (anyOf 1)booleanAlternativeDefault: null
can_skip (anyOf 2)nullAlternative
current_step_in_chainJSONRequired within parent
current_step_in_chain (anyOf 1)JSONAlternative
current_step_in_chain (anyOf 1) (anyOf 1)integerAlternative
current_step_in_chain (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
current_step_in_chain (anyOf 2)nullAlternative
has_blocking_approval_requirementsJSONOptional
has_blocking_approval_requirements (anyOf 1)booleanAlternativeDefault: null
has_blocking_approval_requirements (anyOf 2)nullAlternative
is_last_step_for_userbooleanRequired within parent
is_pausableJSONOptional
is_pausable (anyOf 1)booleanAlternativeDefault: null
is_pausable (anyOf 2)nullAlternative
last_action_dateJSONRequired within parent
last_action_date (anyOf 1)stringAlternative
last_action_date (anyOf 2)nullAlternative
needs_user_actionbooleanRequired within parent
next_approversarrayRequired within parent
next_approvers[]ModelEach itemExpand Fetch a vendor agreement — response body — pending spend requests item approval chain metadata next approvers item
number_of_approvalsJSONRequired within parent
number_of_approvals (anyOf 1)integerAlternative
number_of_approvals (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
rejection_noteJSONOptional
rejection_note (anyOf 1)stringAlternativeDefault: null
rejection_note (anyOf 2)nullAlternative
statusstringRequired within parentKnown values: APPROVED, INITIALIZED, PENDING, REJECTED, TERMINATED
total_number_of_approvalsJSONRequired within parent
total_number_of_approvals (anyOf 1)integerAlternative
total_number_of_approvals (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
total_steps_in_chainJSONRequired within parent
total_steps_in_chain (anyOf 1)integerAlternative
total_steps_in_chain (anyOf 2)stringAlternativePattern: ^-?[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

FieldTypePresenceDescription and constraints
$objectRoot
can_send_reminderbooleanRequired within parent
period_in_daysJSONRequired within parent
period_in_days (anyOf 1)integerAlternative
period_in_days (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
reminder_communication_last_sent_atstringRequired 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

FieldTypePresenceDescription and constraints
$objectRoot
deleted_atJSONRequired within parent
deleted_at (anyOf 1)stringAlternative
deleted_at (anyOf 2)nullAlternative
emailstringRequired within parent
first_namestringRequired within parent
idstringRequired within parent
last_namestringRequired within parent
lifecycle_statusJSONOptional
lifecycle_status (anyOf 1)stringAlternativeRepresents 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)nullAlternative
profile_picture_urlJSONRequired within parent
profile_picture_url (anyOf 1)stringAlternative
profile_picture_url (anyOf 2)nullAlternative
rolestringRequired within parentKnown 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

FieldTypePresenceDescription and constraints
$objectRoot
approval_trigger_instance_error_messageJSONRequired within parent
approval_trigger_instance_error_message (anyOf 1)stringAlternative
approval_trigger_instance_error_message (anyOf 2)nullAlternative
approval_trigger_instance_error_redirect_urlJSONRequired within parent
approval_trigger_instance_error_redirect_url (anyOf 1)stringAlternative
approval_trigger_instance_error_redirect_url (anyOf 2)nullAlternative
approval_trigger_typeJSONRequired within parent
approval_trigger_type (anyOf 1)stringAlternativeKnown 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)nullAlternative
assigned_user_full_namestringRequired within parent
assigned_user_idJSONRequired within parent
assigned_user_id (anyOf 1)stringAlternative
assigned_user_id (anyOf 2)nullAlternative
can_create_esign_envelopeJSONOptional
can_create_esign_envelope (anyOf 1)booleanAlternativeWhether 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)nullAlternative
delegator_user_full_nameJSONRequired within parent
delegator_user_full_name (anyOf 1)stringAlternative
delegator_user_full_name (anyOf 2)nullAlternative
delegator_user_idJSONRequired within parent
delegator_user_id (anyOf 1)stringAlternative
delegator_user_id (anyOf 2)nullAlternative
entity_full_namestringRequired within parent
entity_idJSONRequired within parent
entity_id (anyOf 1)stringAlternative
entity_id (anyOf 2)nullAlternative
entity_typestringRequired within parentKnown values: ANY_ADMIN, GROUP, MANAGER, TRIGGER, USER, VENDOR_OWNER, VENDOR_OWNER_MANAGER
external_urlJSONRequired within parent
external_url (anyOf 1)stringAlternative
external_url (anyOf 2)nullAlternative
notesJSONRequired within parent
notes (anyOf 1)stringAlternative
notes (anyOf 2)nullAlternative
provider_typeJSONOptional
provider_type (anyOf 1)stringAlternativeDefault: null
provider_type (anyOf 2)nullAlternative

Fetch a vendor agreement — response body — purchase orders item

FieldTypePresenceDescription and constraints
$objectRoot
can_viewbooleanRequired within parentWhether the current user has permission to view this purchase order.
documentsarrayRequired within parent
documents[]objectEach item
end_dateJSONRequired within parent
end_date (anyOf 1)stringAlternativeEnd date of the purchase order.
Default: null
Format: date
end_date (anyOf 2)nullAlternative
idstringRequired within parentUnique identifier for the purchase order.
nameJSONRequired within parent
name (anyOf 1)stringAlternativeName of the purchase order.
Default: null
name (anyOf 2)nullAlternative
paid_by_bill_amountModelRequired within parentExpand Hold Bill — response body — amount
paid_by_card_amountModelRequired within parentExpand Hold Bill — response body — amount
pending_bill_amountModelRequired within parentExpand Hold Bill — response body — amount
purchase_order_numberJSONRequired within parent
purchase_order_number (anyOf 1)stringAlternativeExternal purchase order number.
Default: null
purchase_order_number (anyOf 2)nullAlternative
spend_requestModelRequired within parentExpand Fetch a vendor agreement — response body — purchase orders item spend request
start_dateJSONRequired within parent
start_date (anyOf 1)stringAlternativeStart date of the purchase order.
Default: null
Format: date
start_date (anyOf 2)nullAlternative
statusJSONOptional
status (anyOf 1)stringAlternativeKnown values: CLOSED, DELETED, FULLY_BILLED, OPEN, PARTIALLY_BILLED
status (anyOf 2)nullAlternative
total_amountModelRequired within parentExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
approved_atJSONRequired within parent
approved_at (anyOf 1)stringAlternativeDate when the spend request was approved.
Default: null
Format: date
approved_at (anyOf 2)nullAlternative
currencystringRequired within parentCurrency code for the spend request amounts.
idstringRequired within parentFormat: uuid
nameJSONRequired within parent
name (anyOf 1)stringAlternativeName of the spend request.
Default: null
name (anyOf 2)nullAlternative
sourcestringRequired within parentKnown values: EXPANSION_REQUEST, RENEWAL, REQUEST_APPROVAL, REQUEST_LINKED_TO_AGREEMENT
submitted_atJSONOptional
submitted_at (anyOf 1)stringAlternativeFormat: date-time
submitted_at (anyOf 2)nullAlternative
total_amountJSONOptional
total_amount (anyOf 1)ModelAlternativeExpand Hold Bill — response body — amount
total_amount (anyOf 2)nullAlternative
unified_request_idstringRequired within parentFormat: uuid
user_full_namestringRequired within parentFull name of the user who created the spend request.

Referenced models: Hold Bill — response body — amount

Fetch a vendor bank account — response body

FieldTypePresenceDescription and constraints
$objectRoot
account_nicknamestringOptionalNickname of the vendor bank account.
account_number_last_fourJSONRequired within parent
account_number_last_four (anyOf 1)stringAlternativeLast four digits of the bank account number.
Read only: true
account_number_last_four (anyOf 2)nullAlternative
currencystringRequired within parentCurrency 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
idstringRequired within parentUnique identifier of the vendor bank account.
Format: uuid
is_defaultbooleanRequired within parentWhether this is the payee's default bank account. For a pending account, whether its vendor edit makes it the default.
Read only: true
payment_methodstringRequired within parentSupported 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_idJSONRequired within parent
proposal_id (anyOf 1)stringAlternativeCurrent 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)nullAlternative
statusstringRequired within parentApproval status of the vendor bank account.
Known values: active, pending_approval, pending_deletion
Read only: true

Fetch a vendor contact — response body

FieldTypePresenceDescription and constraints
$objectRoot
emailJSONRequired within parent
email (anyOf 1)stringAlternative
email (anyOf 2)nullAlternative
first_nameJSONRequired within parent
first_name (anyOf 1)stringAlternative
first_name (anyOf 2)nullAlternative
idstringRequired within parentUnique identifier of the vendor contact.
Format: uuid
is_defaultbooleanRequired within parent
last_nameJSONRequired within parent
last_name (anyOf 1)stringAlternative
last_name (anyOf 2)nullAlternative
phoneJSONRequired within parent
phone (anyOf 1)stringAlternative
phone (anyOf 2)nullAlternative

Fetch a vendor credit — response body

FieldTypePresenceDescription and constraints
$objectRoot
accounting_datestringRequired within parentAccounting date of the vendor credit
Format: date
accounting_field_selectionsarrayRequired within parentList of accounting field selections associated with this vendor credit
Read only: true
accounting_field_selections[]ModelEach itemExpand Hold Bill — response body — accounting field selections item
applied_billsarrayRequired within parentBills that this Vendor Credit has been applied to. A Vendor Credit can be applied to multiple Bills
Read only: true
applied_bills[]ModelEach itemExpand Fetch a vendor credit — response body — applied bills item
applied_draft_billsarrayRequired within parentDraft 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[]ModelEach itemExpand Fetch a vendor credit — response body — applied bills item
archived_atJSONRequired within parent
archived_at (anyOf 1)stringAlternativeThe 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)nullAlternative
created_atJSONRequired within parent
created_at (anyOf 1)stringAlternativeDate and time when the vendor credit was created
Format: date-time
created_at (anyOf 2)nullAlternative
entity_idJSONRequired within parent
entity_id (anyOf 1)stringAlternativeUUID of the business entity associated with this vendor credit
Format: uuid
entity_id (anyOf 2)nullAlternative
expense_line_itemsarrayRequired within parentExpense line items of the vendor credit. Expense line items contain an overall amount.
expense_line_items[]ModelEach itemExpand Fetch a vendor credit — response body — expense line items item
idstringRequired within parentUnique identifier for the vendor credit
inventory_line_itemsarrayRequired within parentInventory line items of the vendor credit. Inventory line items are tied to a particular good or service.
inventory_line_items[]ModelEach itemExpand Fetch a vendor credit — response body — inventory line items item
reference_bill_idJSONRequired within parent
reference_bill_id (anyOf 1)stringAlternativeUUID of the bill that was the origin of this vendor credit, if any
Format: uuid
reference_bill_id (anyOf 2)nullAlternative
reference_numberJSONRequired within parent
reference_number (anyOf 1)stringAlternativeReference number from the vendor credit memo
reference_number (anyOf 2)nullAlternative
remaining_amountModelRequired within parentExpand 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_amountModelRequired within parentExpand 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_amountModelRequired within parentExpand 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_idstringRequired within parentUUID 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

FieldTypePresenceDescription and constraints
$objectRoot
amountModelRequired within parentExpand 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_idstringRequired within parentUUID 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

FieldTypePresenceDescription and constraints
$objectRoot
accounting_field_selectionsarrayRequired within parentList of accounting field options selected to code the line item.
accounting_field_selections[]ModelEach itemExpand Hold Bill — response body — accounting field selections item
amountModelRequired within parentExpand Hold Bill — response body — amount
Amount of the line item, in the Vendor Credit's currency.
Read only: true
memostringOptionalMemo 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

FieldTypePresenceDescription and constraints
$objectRoot
accounting_field_selectionsarrayRequired within parentList of accounting field options selected to code the line item.
accounting_field_selections[]ModelEach itemExpand Hold Bill — response body — accounting field selections item
amountModelRequired within parentExpand 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
memostringOptionalMemo of the line item
unit_priceModelRequired within parentExpand Hold Bill — response body — amount
Unit price of the line item, in the Vendor Credit's currency.
Read only: true
unit_quantityJSONRequired within parent
unit_quantity (anyOf 1)numberAlternativeUnit quantity of the line item
unit_quantity (anyOf 2)stringAlternativePattern: ^-?[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

FieldTypePresenceDescription and constraints
$objectRoot
accounting_vendor_remote_idJSONRequired within parent
accounting_vendor_remote_id (anyOf 1)stringAlternativeThe accounting remote id of the vendor.
accounting_vendor_remote_id (anyOf 2)nullAlternative
addressModelOptionalExpand Create a new vendor — response body — address
The default address of the vendor.
addressesarrayRequired within parentThe addresses of the vendor.
addresses[]ModelEach itemExpand Create a new vendor — response body — addresses item
approval_statusstringRequired within parentApproval status of the vendor.
Known values: APPROVED, PENDING, REJECTED
billing_frequencystringOptionalThe billing frequency for this vendor.
Known values: ANNUAL, MONTHLY, MULTIPLE, NA, OTHER, QUARTERLY, ROLLING, TBD, TWICE_A_YEAR
contactsarrayRequired within parentUnique identifiers of contacts associated with this vendor.
contacts[]stringEach itemUnique identifier of the vendor contact.
Format: uuid
countrystringRequired within parentThe 2-letter country of the vendor.
created_atstringRequired within parentThe date and time when this vendor was created.
Format: date-time
custom_form_collection_responseJSONRequired within parent
custom_form_collection_response (anyOf 1)ModelAlternativeExpand 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)nullAlternative
custom_record_fieldsJSONRequired within parent
custom_record_fields (anyOf 1)arrayAlternativeRead only: true
custom_record_fields (anyOf 1)[]ModelEach itemExpand Get a business entity — response body — custom record fields item
custom_record_fields (anyOf 2)nullAlternative
default_entity_idJSONRequired within parent
default_entity_id (anyOf 1)stringAlternativeUnique identifier of the default business entity associated with this vendor.
Format: uuid
default_entity_id (anyOf 2)nullAlternative
default_payment_methodJSONRequired within parent
default_payment_method (anyOf 1)ModelAlternativeExpand 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)nullAlternative
descriptionstringOptionalDescription of the vendor.
display_nameJSONRequired within parent
display_name (anyOf 1)stringAlternativeDisplay name of the vendor.
display_name (anyOf 2)nullAlternative
external_vendor_idJSONRequired within parent
external_vendor_id (anyOf 1)stringAlternativeCustomer-defined external identifier for the vendor. This is independent of accounting system remote IDs.
external_vendor_id (anyOf 2)nullAlternative
federal_tax_classificationstringOptionalThe 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
idstringRequired within parentUnique identifier of the vendor.
Format: uuid
is_activebooleanRequired within parentWhether this vendor is active.
is_deletablebooleanRequired within parentWhether this vendor is deletable.
Read only: true
merchant_idstringOptionalThe id of the card merchant.
Format: uuid
namestringRequired within parentName of the vendor.
name_legalstringOptionalLegal name of the vendor.
net_payment_termsJSONOptional
net_payment_terms (anyOf 1)JSONAlternative
net_payment_terms (anyOf 1) (anyOf 1)integerAlternativeNumber of days after receipt that payment is due. 0 means due on receipt.
net_payment_terms (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
net_payment_terms (anyOf 2)nullAlternative
parent_vendor_idJSONRequired within parent
parent_vendor_id (anyOf 1)stringAlternativeUnique identifier of the parent vendor, if this vendor has one.
Format: uuid
Read only: true
parent_vendor_id (anyOf 2)nullAlternative
sk_category_idJSONOptional
sk_category_id (anyOf 1)integerAlternativeRamp 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)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
sk_category_namestringOptionalThe category name of the vendor.
statestringOptional
subsidiaryarrayOptionalERP subsidiary identifiers associated with this vendor. Only returned when `include_subsidiary=true`.
Read only: true
subsidiary[]stringEach item
tax_addressModelOptionalExpand Create a new vendor — response body — address
The tax address of the vendor.
total_spend_all_timeModelRequired within parentExpand Hold Bill — response body — amount
Total spend for all time for this vendor.
Read only: true
total_spend_last_30_daysModelRequired within parentExpand Hold Bill — response body — amount
Total spend for the last 30 days for this vendor.
Read only: true
total_spend_last_365_daysModelRequired within parentExpand Hold Bill — response body — amount
Total spend for the last 365 days for this vendor.
Read only: true
total_spend_ytdModelRequired within parentExpand Hold Bill — response body — amount
Total spend year-to-date for this vendor.
Read only: true
updated_atJSONRequired within parent
updated_at (anyOf 1)stringAlternativeThe date and time when this vendor was last updated.
Format: date-time
updated_at (anyOf 2)nullAlternative
vendor_owner_idJSONRequired within parent
vendor_owner_id (anyOf 1)stringAlternativeUnique identifier of the user which owns this vendor.
Format: uuid
Read only: true
vendor_owner_id (anyOf 2)nullAlternative
vendor_typestringOptionalThe 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

FieldTypePresenceDescription and constraints
$objectRoot
sourcestringRequired within parentType of agreement relationship to create for the spend request. Supported values are RENEWAL and EXPANSION_REQUEST.
One of: EXPANSION_REQUEST, RENEWAL
spend_request_idstringRequired within parentUnique identifier of the spend request to link to the agreement.
Format: uuid

Link a spend request to a vendor agreement — response body

FieldTypePresenceDescription and constraints
$objectRoot
agreementModelRequired within parentExpand Fetch a vendor agreement — response body
number_of_documents_linkedJSONRequired within parent
number_of_documents_linked (anyOf 1)integerAlternativeNumber of documents linked to the agreement.
number_of_documents_linked (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
number_of_purchase_orders_linkedJSONRequired within parent
number_of_purchase_orders_linked (anyOf 1)integerAlternativeNumber of purchase orders linked to the agreement.
number_of_purchase_orders_linked (anyOf 2)stringAlternativePattern: ^-?[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

FieldTypePresenceDescription and constraints
$objectRoot
documentsarrayOptionalExisting documents to link to the agreement.
documents[]ModelEach itemExpand Link purchase orders or documents to a vendor agreement — request body — body documents item
purchase_order_idsarrayOptionalUnique identifiers of purchase orders to link to the agreement.
purchase_order_ids[]stringEach 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

FieldTypePresenceDescription and constraints
$JSONRootdiscriminator: {"mapping": {"CUSTOM_FORM_FILE": "#/components/schemas/ApiVendorAgreementCustomFormFileLinkInputRequestBody", "PAYEE_DOCUMENT": "#/components/schemas/ApiVendorAgreementPayeeDocumentLinkInputRequestBody", "SPEND_REQUEST_DOCUMENT": "#/components/schemas/ApiVendorAgreementSpendRequestDocumentLinkInputRequestBody"}, "propertyName": "type"}
$ (oneOf 1)ModelAlternativeExpand Link purchase orders or documents to a vendor agreement — request body — body documents item type CUSTOM FORM FILE
$ (oneOf 2)ModelAlternativeExpand Link purchase orders or documents to a vendor agreement — request body — body documents item type PAYEE DOCUMENT
$ (oneOf 3)ModelAlternativeExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
idstringRequired within parentUnique identifier of the document or file to link.
Format: uuid
typestringOptionalDocument source type.
Must equal: CUSTOM_FORM_FILE

Link purchase orders or documents to a vendor agreement — request body — body documents item type PAYEE DOCUMENT

FieldTypePresenceDescription and constraints
$objectRoot
idstringRequired within parentUnique identifier of the document or file to link.
Format: uuid
typestringOptionalDocument source type.
Must equal: PAYEE_DOCUMENT

Link purchase orders or documents to a vendor agreement — request body — body documents item type SPEND REQUEST DOCUMENT

FieldTypePresenceDescription and constraints
$objectRoot
idstringRequired within parentUnique identifier of the document or file to link.
Format: uuid
typestringOptionalDocument source type.
Must equal: SPEND_REQUEST_DOCUMENT

List available payment methods for a vendor — response body

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

Referenced models: List bills — response body — page, List available payment methods for a vendor — response body — data item

List available payment methods for a vendor — response body — data item

FieldTypePresenceDescription and constraints
$JSONRootdiscriminator: {"mapping": {"ACH": "#/components/schemas/ApiVendorAchPaymentMethodResource", "CHECK": "#/components/schemas/ApiVendorCheckPaymentMethodResource"}, "propertyName": "type"}
$ (anyOf 1)ModelAlternativeExpand List available payment methods for a vendor — response body — data item type ACH
$ (anyOf 2)ModelAlternativeExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
account_number_last_fourstringRequired within parentLast four digits of the bank account number.
Maximum length: 4
Minimum length: 4
feeModelRequired within parentExpand Hold Bill — response body — amount
The fee charged for using this payment method.
idstringRequired within parentUnique identifier of the payment method.
Format: uuid
routing_number_last_fourstringRequired within parentLast four digits of the routing number.
Maximum length: 4
Minimum length: 4
typestringRequired within parentThe 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

FieldTypePresenceDescription and constraints
$objectRoot
feeModelRequired within parentExpand Hold Bill — response body — amount
The fee charged for using this payment method.
idstringRequired within parentUnique identifier of the payment method.
Format: uuid
mailing_addressModelRequired within parentExpand List available payment methods for a vendor — response body — data item type CHECK mailing address
The mailing address for check delivery.
typestringRequired within parentThe 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

FieldTypePresenceDescription and constraints
$objectRoot
address_line_1stringRequired within parentPrimary address line.
address_line_2JSONRequired within parent
address_line_2 (anyOf 1)stringAlternativeSecondary address line.
Default: null
address_line_2 (anyOf 2)nullAlternative
citystringRequired within parentCity name.
countrystringRequired within parentTwo-letter ISO 3166-1 country code.
postal_codestringRequired within parentPostal or ZIP code.
stateJSONRequired within parent
state (anyOf 1)stringAlternativeState or province abbreviation.
Default: null
Maximum length: 2
Minimum length: 2
state (anyOf 2)nullAlternative

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.