Skip to content

Ramp: Vendor schemas (part 2)

42 Ramp schemas with complete fields and constraints.

← Vendor operations · All schemas

List child vendors of a parent vendor — response body

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

Referenced models: List bills — response body — page, Create a new vendor — response body

List vendor agreements — request body — body

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

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

List vendor agreements — request body — body agreement custom records type and

FieldTypePresenceDescription and constraints
$objectRoot
filtersarrayRequired within parent
filters[]JSONEach itemdiscriminator: {"mapping": {"and": "#/components/schemas/CustomRecordsQueryAndClauseRequestBody", "filter": "#/components/schemas/RowQueryFilterRequestBody", "or": "#/components/schemas/CustomRecordsQueryOrClauseRequestBody"}, "propertyName": "type"}
filters[] (oneOf 1)ModelAlternativeExpand List vendor agreements — request body — body agreement custom records type and
filters[] (oneOf 2)ModelAlternativeExpand List vendor agreements — request body — body agreement custom records type and filters item type or
filters[] (oneOf 3)ModelAlternativeExpand List vendor agreements — request body — body agreement custom records type and filters item type filter
typestringOptionalMust equal: and

Referenced models: List vendor agreements — request body — body agreement custom records type and, List vendor agreements — request body — body agreement custom records type and filters item type or, List vendor agreements — request body — body agreement custom records type and filters item type filter

List vendor agreements — request body — body agreement custom records type and filters item type filter

FieldTypePresenceDescription and constraints
$objectRoot
clauseJSONRequired within parentdiscriminator: {"mapping": {"greater_than": "#/components/schemas/RowQueryGreaterThanClauseRequestBody", "greater_than_or_equal": "#/components/schemas/RowQueryGreaterThanOrEqualClauseRequestBody", "is_not": "#/components/schemas/RowQueryIsNotClauseRequestBody", "is_not_null": "#/components/schemas/RowQueryIsNotNullClauseRequestBody", "is_null": "#/components/schemas/RowQueryIsNullClauseRequestBody", "less_than": "#/components/schemas/RowQueryLessThanClauseRequestBody", "less_than_or_equal": "#/components/schemas/RowQueryLessThanOrEqualClauseRequestBody", "one_of": "#/components/schemas/RowQueryOneOfClauseRequestBody"}, "propertyName": "type"}
clause (oneOf 1)ModelAlternativeExpand List vendor agreements — request body — body agreement custom records type and filters item type filter clause type greater than
clause (oneOf 2)ModelAlternativeExpand List vendor agreements — request body — body agreement custom records type and filters item type filter clause type greater than or equal
clause (oneOf 3)ModelAlternativeExpand List vendor agreements — request body — body agreement custom records type and filters item type filter clause type is not
clause (oneOf 4)ModelAlternativeExpand List vendor agreements — request body — body agreement custom records type and filters item type filter clause type is not null
clause (oneOf 5)ModelAlternativeExpand List vendor agreements — request body — body agreement custom records type and filters item type filter clause type is null
clause (oneOf 6)ModelAlternativeExpand List vendor agreements — request body — body agreement custom records type and filters item type filter clause type less than
clause (oneOf 7)ModelAlternativeExpand List vendor agreements — request body — body agreement custom records type and filters item type filter clause type less than or equal
clause (oneOf 8)ModelAlternativeExpand List vendor agreements — request body — body agreement custom records type and filters item type filter clause type one of
column_idstringRequired within parent
typestringOptionalMust equal: filter

Referenced models: List vendor agreements — request body — body agreement custom records type and filters item type filter clause type greater than, List vendor agreements — request body — body agreement custom records type and filters item type filter clause type greater than or equal, List vendor agreements — request body — body agreement custom records type and filters item type filter clause type is not, List vendor agreements — request body — body agreement custom records type and filters item type filter clause type is not null, List vendor agreements — request body — body agreement custom records type and filters item type filter clause type is null, List vendor agreements — request body — body agreement custom records type and filters item type filter clause type less than, List vendor agreements — request body — body agreement custom records type and filters item type filter clause type less than or equal, List vendor agreements — request body — body agreement custom records type and filters item type filter clause type one of

List vendor agreements — request body — body agreement custom records type and filters item type filter clause type greater than

FieldTypePresenceDescription and constraints
$objectRoot
typestringOptionalMust equal: greater_than
valueJSONRequired within parent
value (oneOf 1)stringAlternativeFormat: date-time
value (oneOf 2)numberAlternative
value (oneOf 3)stringAlternative

List vendor agreements — request body — body agreement custom records type and filters item type filter clause type greater than or equal

FieldTypePresenceDescription and constraints
$objectRoot
typestringOptionalMust equal: greater_than_or_equal
valueJSONRequired within parent
value (oneOf 1)stringAlternativeFormat: date-time
value (oneOf 2)numberAlternative
value (oneOf 3)stringAlternative

List vendor agreements — request body — body agreement custom records type and filters item type filter clause type is not

FieldTypePresenceDescription and constraints
$objectRoot
typestringOptionalMust equal: is_not
valuesJSONRequired within parent
values (oneOf 1)arrayAlternative
values (oneOf 1)[]stringEach itemFormat: date-time
values (oneOf 2)arrayAlternative
values (oneOf 2)[]JSONEach item
values (oneOf 2)[] (oneOf 1)numberAlternative
values (oneOf 2)[] (oneOf 2)stringAlternative
values (oneOf 3)arrayAlternative
values (oneOf 3)[]booleanEach item
values (oneOf 4)arrayAlternative
values (oneOf 4)[]stringEach item

List vendor agreements — request body — body agreement custom records type and filters item type filter clause type is not null

FieldTypePresenceDescription and constraints
$objectRoot
typestringOptionalMust equal: is_not_null

List vendor agreements — request body — body agreement custom records type and filters item type filter clause type is null

FieldTypePresenceDescription and constraints
$objectRoot
typestringOptionalMust equal: is_null

List vendor agreements — request body — body agreement custom records type and filters item type filter clause type less than

FieldTypePresenceDescription and constraints
$objectRoot
typestringOptionalMust equal: less_than
valueJSONRequired within parent
value (oneOf 1)stringAlternativeFormat: date-time
value (oneOf 2)numberAlternative
value (oneOf 3)stringAlternative

List vendor agreements — request body — body agreement custom records type and filters item type filter clause type less than or equal

FieldTypePresenceDescription and constraints
$objectRoot
typestringOptionalMust equal: less_than_or_equal
valueJSONRequired within parent
value (oneOf 1)stringAlternativeFormat: date-time
value (oneOf 2)numberAlternative
value (oneOf 3)stringAlternative

List vendor agreements — request body — body agreement custom records type and filters item type filter clause type one of

FieldTypePresenceDescription and constraints
$objectRoot
typestringOptionalMust equal: one_of
valuesJSONRequired within parent
values (oneOf 1)arrayAlternative
values (oneOf 1)[]stringEach itemFormat: date-time
values (oneOf 2)arrayAlternative
values (oneOf 2)[]JSONEach item
values (oneOf 2)[] (oneOf 1)numberAlternative
values (oneOf 2)[] (oneOf 2)stringAlternative
values (oneOf 3)arrayAlternative
values (oneOf 3)[]booleanEach item
values (oneOf 4)arrayAlternative
values (oneOf 4)[]stringEach item

List vendor agreements — request body — body agreement custom records type and filters item type or

FieldTypePresenceDescription and constraints
$objectRoot
filtersarrayRequired within parent
filters[]JSONEach itemdiscriminator: {"mapping": {"and": "#/components/schemas/CustomRecordsQueryAndClauseRequestBody", "filter": "#/components/schemas/RowQueryFilterRequestBody", "or": "#/components/schemas/CustomRecordsQueryOrClauseRequestBody"}, "propertyName": "type"}
filters[] (oneOf 1)ModelAlternativeExpand List vendor agreements — request body — body agreement custom records type and
filters[] (oneOf 2)ModelAlternativeExpand List vendor agreements — request body — body agreement custom records type and filters item type or
filters[] (oneOf 3)ModelAlternativeExpand List vendor agreements — request body — body agreement custom records type and filters item type filter
typestringOptionalMust equal: or

Referenced models: List vendor agreements — request body — body agreement custom records type and, List vendor agreements — request body — body agreement custom records type and filters item type or, List vendor agreements — request body — body agreement custom records type and filters item type filter

List vendor agreements — request body — body end date range end, start

FieldTypePresenceDescription and constraints
$objectRootConcrete relative date range for agreement date filters.
endModelOptionalExpand List vendor agreements — request body — body end date range end, start end
End date offset, always snapped to end of period
startModelOptionalExpand List vendor agreements — request body — body end date range end, start end
Start date offset, always snapped to beginning of period

Referenced models: List vendor agreements — request body — body end date range end, start end

List vendor agreements — request body — body end date range end, start end

FieldTypePresenceDescription and constraints
$objectRootRepresents a date relative to the current date that automatically snaps to period boundaries.

Examples:
# Last complete month (snapping determined by context)
RelativeDateOffset(unit="month", offset=-1)

# Current year
RelativeDateOffset(unit="year", offset=0)
offsetintegerRequired within parentNumber of units to offset. Negative for past, positive for future. Example: -1 month = previous month
unitstringRequired within parentUnits of time for relative date offsets.
The unit of time (day, week, quarter, month, year)
One of: day, month, quarter, week, year

List vendor agreements — response body

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

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

List vendor agreements — response body — data / item / latest_renewal_request / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED

FieldTypePresenceDescription and constraints
$objectRoot
currencystringRequired within parent
idstringRequired within parentFormat: uuid
nameJSONOptional
name (anyOf 1)stringAlternative
name (anyOf 2)nullAlternative
request_statusstringRequired within parentKnown values: APPROVED, DRAFT, REJECTED, SUBMITTED
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 parent

Referenced models: Hold Bill — response body — amount

List vendor agreements — response body — data item

FieldTypePresenceDescription and constraints
$objectRoot
auto_renewalbooleanRequired within parent
available_actionsobjectRequired within parent
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 parent
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
departmentJSONOptional
department (anyOf 1)ModelAlternativeExpand List vendor agreements — response body — data item department id, name
department (anyOf 2)nullAlternative
descriptionJSONOptional
description (anyOf 1)stringAlternative
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_dateJSONOptional
end_date (anyOf 1)stringAlternativeFormat: date
end_date (anyOf 2)nullAlternative
has_approved_renewal_requestbooleanRequired within parent
idstringRequired within parentFormat: uuid
is_snoozedbooleanRequired within parent
is_up_for_renewalbooleanRequired within parent
last_date_to_terminateJSONOptional
last_date_to_terminate (anyOf 1)stringAlternativeFormat: date
last_date_to_terminate (anyOf 2)nullAlternative
latest_renewal_requestJSONOptional
latest_renewal_request (anyOf 1)ModelAlternativeExpand List vendor agreements — response body — data / item / latest_renewal_request / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED
latest_renewal_request (anyOf 2)nullAlternative
logoJSONOptional
logo (anyOf 1)stringAlternative
logo (anyOf 2)nullAlternative
namestringRequired within parent
notifications_onbooleanRequired within parent
payee_idstringRequired within parentFormat: uuid
payee_namestringRequired within parent
renewal_statusstringRequired within parentKnown values: CANCELLED, EVALUATING, EXPIRED, INITIATED, NOT_STARTED, PLANNING, REJECTED, RENEWED, TERMINATED
start_dateJSONOptional
start_date (anyOf 1)stringAlternativeFormat: date
start_date (anyOf 2)nullAlternative
total_valueModelRequired within parentExpand Hold Bill — response body — amount
updated_atstringRequired within parentFormat: date-time
uploaded_by_userJSONOptional
uploaded_by_user (anyOf 1)ModelAlternativeExpand List vendor agreements — response body — data item uploaded by user email, first name, full name, id, last name, profile picture url
Recorded uploader of the source document's latest version, or null when unavailable.
uploaded_by_user (anyOf 2)nullAlternative
vendor_ownersarrayRequired within parent
vendor_owners[]ModelEach itemExpand List vendor agreements — response body — data item vendor owners item

Referenced models: Fetch a vendor agreement — response body — contract owners item, List vendor agreements — response body — data item department id, name, List vendor agreements — response body — data item uploaded by user email, first name, full name, id, last name, profile picture url, List vendor agreements — response body — data item vendor owners item, Fetch a vendor agreement — response body — days remaining, Fetch a vendor agreement — response body — draft spend requests item, List vendor agreements — response body — data / item / latest_renewal_request / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED, Hold Bill — response body — amount, Get a business entity — response body — custom record fields item

List vendor agreements — response body — data item department id, name

FieldTypePresenceDescription and constraints
$objectRoot
idstringRequired within parentFormat: uuid
namestringRequired within parent

List vendor agreements — response body — data item uploaded by user email, first name, full name, id, last name, profile picture url

FieldTypePresenceDescription and constraints
$objectRoot
emailstringRequired within parentEmail address of the user who uploaded the document.
Format: email
first_namestringRequired within parentFirst name of the user who uploaded the document.
full_namestringRequired within parentFull name of the user who uploaded the document.
idstringRequired within parentUnique identifier of the user who uploaded the source document.
Format: uuid
last_namestringRequired within parentLast name of the user who uploaded the document.
profile_picture_urlJSONOptional
profile_picture_url (anyOf 1)stringAlternativeProfile picture URL of the user who uploaded the document.
profile_picture_url (anyOf 2)nullAlternative

List vendor agreements — response body — data item vendor owners item

FieldTypePresenceDescription and constraints
$objectRoot
first_namestringRequired within parent
full_namestringRequired within parent
idstringRequired within parentFormat: uuid
last_namestringRequired within parent

List vendor bank accounts — response body

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

Referenced models: List bills — response body — page, Fetch a vendor bank account — response body

List vendor contacts for vendor — response body

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

Referenced models: Fetch a vendor contact — response body, List bills — response body — page

List vendor credits by vendor — request body — query

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
entity_idJSONOptional
entity_id (anyOf 1)stringAlternativeDefault: null
Format: uuid
entity_id (anyOf 2)nullAlternative
from_created_atJSONOptional
from_created_at (anyOf 1)stringAlternativeDefault: null
Format: date-time
from_created_at (anyOf 2)nullAlternative
to_created_atJSONOptional
to_created_at (anyOf 1)stringAlternativeDefault: null
Format: date-time
to_created_at (anyOf 2)nullAlternative
from_accounting_dateJSONOptional
from_accounting_date (anyOf 1)stringAlternativeDefault: null
Format: date
from_accounting_date (anyOf 2)nullAlternative
to_accounting_dateJSONOptional
to_accounting_date (anyOf 1)stringAlternativeDefault: null
Format: date
to_accounting_date (anyOf 2)nullAlternative
include_fully_usedbooleanOptionalDefault: false
is_archivedbooleanOptionalDefault: false
startstringOptional
page_sizeintegerOptionalDefault: 20

List vendor credits by vendor — response body

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

Referenced models: List bills — response body — page, Fetch a vendor credit — response body

Place a hold on a vendor — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
reasonJSONOptional
reason (anyOf 1)stringAlternativeOptional reason for placing the vendor on hold.
Default: null
reason (anyOf 2)nullAlternative

Unlink purchase orders or documents from a vendor agreement — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
documentsarrayOptionalExisting documents to unlink from 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 unlink from the agreement.
purchase_order_ids[]stringEach item

Referenced models: Link purchase orders or documents to a vendor agreement — request body — body documents item

Unlink purchase orders or documents from a vendor agreement — response body

FieldTypePresenceDescription and constraints
$objectRoot
agreementModelRequired within parentExpand Fetch a vendor agreement — response body
number_of_documents_unlinkedJSONRequired within parent
number_of_documents_unlinked (anyOf 1)integerAlternativeNumber of documents unlinked from the agreement.
number_of_documents_unlinked (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
number_of_purchase_orders_unlinkedJSONRequired within parent
number_of_purchase_orders_unlinked (anyOf 1)integerAlternativeNumber of purchase orders unlinked from the agreement.
number_of_purchase_orders_unlinked (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: Fetch a vendor agreement — response body

Update a vendor agreement — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
auto_renewalbooleanOptionalWhether the agreement automatically renews.
contract_owner_idsarrayOptionalList of contract owner user IDs.
contract_owner_ids[]stringEach itemFormat: uuid
descriptionJSONOptional
description (anyOf 1)stringAlternativeDescription of the vendor agreement.
description (anyOf 2)nullAlternative
end_dateJSONOptional
end_date (anyOf 1)stringAlternativeEnd date of the agreement.
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.
Format: date
last_date_to_terminate (anyOf 2)nullAlternative
namestringOptionalName of the vendor agreement.
Minimum length: 1
notifications_onbooleanOptionalWhether notifications are enabled for this agreement.
renewal_actionModelOptionalExpand Update a vendor agreement — request body — body renewal action
Renewal action update payload. Supported types are ACTIVE, RENEWED, and CANCELLED.
Schema name: ApiVendorAgreementRenewalActionInput
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.
renewal_notification_settings (anyOf 2)nullAlternative
renewal_notification_snoozeJSONOptional
renewal_notification_snooze (anyOf 1)ModelAlternativeExpand Update a vendor agreement — request body — body renewal notification snooze value
Renewal notification snooze configuration. Deprecated: use renewal_notification_snoozed_until.
Schema name: ApiVendorAgreementRenewalNotificationSnoozeInput
renewal_notification_snooze (anyOf 2)nullAlternative
renewal_notification_snoozed_untilJSONOptional
renewal_notification_snoozed_until (anyOf 1)stringAlternativeDate when renewal reminders resume. Must be after today and at most one year from today
Date when renewal reminders resume. Must be after today and at most one year from today. Null ends an active snooze.
Format: date
Schema name: ApiVendorAgreementRenewalNotificationSnoozeDate
renewal_notification_snoozed_until (anyOf 2)nullAlternative
start_datestringOptionalStart date of the agreement.
Format: date
total_valueModelOptionalExpand 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 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, Update a vendor agreement — request body — body renewal action, Update a vendor agreement — request body — body renewal notification snooze value

Update a vendor agreement — request body — body renewal action

FieldTypePresenceDescription and constraints
$JSONRootdiscriminator: {"mapping": {"CANCELLED": "#/components/schemas/CancelledActionUpdateRequestBody", "EVALUATING": "#/components/schemas/EvaluatingActionUpdateRequestBody", "NOT_STARTED": "#/components/schemas/ActiveActionUpdateRequestBody", "PLANNING": "#/components/schemas/PlanningActionUpdateRequestBody", "RENEWED": "#/components/schemas/RenewedActionUpdateRequestBody", "TERMINATED": "#/components/schemas/TerminatedActionUpdateRequestBody"}, "propertyName": "type"}
$ (oneOf 1)ModelAlternativeExpand Update a vendor agreement — request body — body renewal action type NOT STARTED
$ (oneOf 2)ModelAlternativeExpand Update a vendor agreement — request body — body renewal action type CANCELLED
$ (oneOf 3)ModelAlternativeExpand Update a vendor agreement — request body — body renewal action type EVALUATING
$ (oneOf 4)ModelAlternativeExpand Update a vendor agreement — request body — body renewal action type PLANNING
$ (oneOf 5)ModelAlternativeExpand Update a vendor agreement — request body — body renewal action type RENEWED
$ (oneOf 6)ModelAlternativeExpand Update a vendor agreement — request body — body renewal action type TERMINATED

Referenced models: Update a vendor agreement — request body — body renewal action type NOT STARTED, Update a vendor agreement — request body — body renewal action type CANCELLED, Update a vendor agreement — request body — body renewal action type EVALUATING, Update a vendor agreement — request body — body renewal action type PLANNING, Update a vendor agreement — request body — body renewal action type RENEWED, Update a vendor agreement — request body — body renewal action type TERMINATED

Update a vendor agreement — request body — body renewal action type CANCELLED

FieldTypePresenceDescription and constraints
$objectRoot
mark_vendor_inactivebooleanOptionalDefault: false
reasonstringRequired within parent
typestringOptionalMarks the agreement as not renewing.
Must equal: CANCELLED

Update a vendor agreement — request body — body renewal action type EVALUATING

FieldTypePresenceDescription and constraints
$objectRoot
typestringOptionalMarks the agreement as evaluating renewal independently of a renewal draft.
Must equal: EVALUATING

Update a vendor agreement — request body — body renewal action type NOT STARTED

FieldTypePresenceDescription and constraints
$objectRoot
typestringOptionalSets the agreement back to active.
Must equal: NOT_STARTED

Update a vendor agreement — request body — body renewal action type PLANNING

FieldTypePresenceDescription and constraints
$objectRoot
typestringOptionalMarks the agreement as planning to renew, independently of a renewal draft.
Must equal: PLANNING

Update a vendor agreement — request body — body renewal action type RENEWED

FieldTypePresenceDescription and constraints
$objectRoot
reasonstringRequired within parent
typestringOptionalMarks the agreement as renewed.
Must equal: RENEWED

Update a vendor agreement — request body — body renewal action type TERMINATED

FieldTypePresenceDescription and constraints
$objectRoot
typestringOptionalMarks the agreement as terminated.
Must equal: TERMINATED

Update a vendor agreement — request body — body renewal notification snooze value

FieldTypePresenceDescription and constraints
$JSONRootdiscriminator: {"mapping": {"DAYS": "#/components/schemas/RenewalNotificationSnoozeDaysRequestBody", "MONTHS": "#/components/schemas/RenewalNotificationSnoozeMonthsRequestBody", "WEEKS": "#/components/schemas/RenewalNotificationSnoozeWeeksRequestBody"}, "propertyName": "unit"}
$ (oneOf 1)ModelAlternativeExpand Update a vendor agreement — request body — body renewal notification snooze value unit DAYS
$ (oneOf 2)ModelAlternativeExpand Update a vendor agreement — request body — body renewal notification snooze value unit MONTHS
$ (oneOf 3)ModelAlternativeExpand Update a vendor agreement — request body — body renewal notification snooze value unit WEEKS

Referenced models: Update a vendor agreement — request body — body renewal notification snooze value unit DAYS, Update a vendor agreement — request body — body renewal notification snooze value unit MONTHS, Update a vendor agreement — request body — body renewal notification snooze value unit WEEKS

Update a vendor agreement — request body — body renewal notification snooze value unit DAYS

FieldTypePresenceDescription and constraints
$objectRootSnooze renewal notifications for a number of days.
durationintegerRequired within parentNumber of days to snooze (1-365)
Maximum: 365
Minimum: 1
unitstringOptionalMust equal: DAYS

Update a vendor agreement — request body — body renewal notification snooze value unit MONTHS

FieldTypePresenceDescription and constraints
$objectRootSnooze renewal notifications for a number of months.
durationintegerRequired within parentNumber of months to snooze (1-12)
Maximum: 12
Minimum: 1
unitstringOptionalMust equal: MONTHS

Update a vendor agreement — request body — body renewal notification snooze value unit WEEKS

FieldTypePresenceDescription and constraints
$objectRootSnooze renewal notifications for a number of weeks.
durationintegerRequired within parentNumber of weeks to snooze (1-52)
Maximum: 52
Minimum: 1
unitstringOptionalMust equal: WEEKS

Update a vendor — vendor patch Vendor Resource — 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.
addressModelOptionalExpand Create a new vendor — request body — body address
The address of the vendor.
countrystringOptionalThe country of the vendor.
default_bank_account_idstringOptionalUnique identifier of an existing bank account belonging to this vendor to use as its default payment method. The account determines the payment method. Existing bills are not changed. Omit to leave the default unchanged.
Format: uuid
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. Set to null to clear the default entity.
Format: uuid
default_entity_id (anyOf 2)nullAlternative
descriptionstringOptionalDescription of the vendor.
display_namestringOptionalDisplay name of the vendor. An empty string clears it.
external_vendor_idJSONOptional
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
is_activebooleanOptionalWhether this vendor is active.
namestringOptionalName of the vendor.
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 the terms. Omit to leave unchanged.
Maximum: 3652058
Minimum: 0
net_payment_terms (anyOf 2)nullAlternative
request_payment_detailsbooleanOptionalWhether to request payment details from the vendor (ACH bank account, international wire transfer, and check mailing address). Requires an existing default vendor contact email.
Default: false
request_tax_detailsbooleanOptionalWhether to request tax information from the vendor (Tax Identification Number, federal tax classification, and tax address). Requires an existing default vendor contact email.
Default: false
stateJSONOptional
state (anyOf 1)stringAlternativeVendor-level two-letter US state abbreviation, such as VA. Required when the vendor country is US. Ignored for non-US vendor countries.
Default: null
state (anyOf 2)nullAlternative
vendor_tracking_category_option_idstringOptionalUnique identifier of the vendor. At most one of `accounting_vendor_remote_id` or `vendor_tracking_category_option_id` should be provided.
Format: uuid

Referenced models: Create a new vendor — request body — body address

Upload documents for a vendor agreement — response body

FieldTypePresenceDescription and constraints
$objectRoot
batch_idstringRequired within parentIdentifier for the created document batch.
document_countJSONRequired within parent
document_count (anyOf 1)integerAlternativeNumber of uploaded documents accepted for processing.
document_count (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
job_idstringRequired within parentAsync job identifier for the upload batch.

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.