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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | Resources returned in this page. |
data[] | Model | Each item | Expand Create a new vendor — response body |
page | Model | Required within parent | Expand List bills — response body — page Pagination details for this response. |
Referenced models: List bills — response body — page, Create a new vendor — response body
List vendor agreements — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
agreement_custom_records | JSON | Optional | |
agreement_custom_records (anyOf 1) | Model | Alternative | Expand List vendor agreements — request body — body agreement custom records type and JSON object describing custom record filters for agreements. Schema name: CustomRecordsQueryAndClauseAdapter |
agreement_custom_records (anyOf 2) | null | Alternative | |
auto_renews | JSON | Optional | |
auto_renews (anyOf 1) | boolean | Alternative | Filter by whether the agreement auto-renews. Default: null |
auto_renews (anyOf 2) | null | Alternative | |
contract_owner_ids | JSON | Optional | |
contract_owner_ids (anyOf 1) | array | Alternative | Filter by contract owner IDs. |
contract_owner_ids (anyOf 1)[] | string | Each item | Format: uuid |
contract_owner_ids (anyOf 2) | null | Alternative | |
department_ids | JSON | Optional | |
department_ids (anyOf 1) | array | Alternative | Filter by department IDs. |
department_ids (anyOf 1)[] | string | Each item | Format: uuid |
department_ids (anyOf 2) | null | Alternative | |
end_date_range | JSON | Optional | |
end_date_range (anyOf 1) | Model | Alternative | Expand List vendor agreements — request body — body end date range end, start JSON object describing a relative end date range filter. |
end_date_range (anyOf 2) | null | Alternative | |
exclude_snoozed | JSON | Optional | |
exclude_snoozed (anyOf 1) | boolean | Alternative | Exclude snoozed agreements when true. Default: null |
exclude_snoozed (anyOf 2) | null | Alternative | |
has_end_date | JSON | Optional | |
has_end_date (anyOf 1) | boolean | Alternative | Filter by whether the agreement has an end date. Default: null |
has_end_date (anyOf 2) | null | Alternative | |
has_pending_expansion_requests | JSON | Optional | |
has_pending_expansion_requests (anyOf 1) | boolean | Alternative | Filter by whether the agreement has pending expansion requests. Default: null |
has_pending_expansion_requests (anyOf 2) | null | Alternative | |
has_reminders | JSON | Optional | |
has_reminders (anyOf 1) | boolean | Alternative | Filter by whether the agreement has reminders configured. Default: null |
has_reminders (anyOf 2) | null | Alternative | |
include_archived | boolean | Optional | Include archived agreements when true. Default: false |
is_active | JSON | Optional | |
is_active (anyOf 1) | boolean | Alternative | Filter by whether the agreement is active. Default: null |
is_active (anyOf 2) | null | Alternative | |
is_up_for_renewal | JSON | Optional | |
is_up_for_renewal (anyOf 1) | boolean | Alternative | Filter by whether the agreement is up for renewal. Default: null |
is_up_for_renewal (anyOf 2) | null | Alternative | |
last_date_to_terminate_range | JSON | Optional | |
last_date_to_terminate_range (anyOf 1) | Model | Alternative | Expand List vendor agreements — request body — body end date range end, start JSON object describing a relative last date to terminate range filter. |
last_date_to_terminate_range (anyOf 2) | null | Alternative | |
max_days_remaining | JSON | Optional | |
max_days_remaining (anyOf 1) | integer | Alternative | Filter by agreements with days remaining less than or equal to this value. Default: null |
max_days_remaining (anyOf 2) | null | Alternative | |
max_end_date | JSON | Optional | |
max_end_date (anyOf 1) | string | Alternative | Filter by agreements whose end date is on or before the provided date. Default: null Format: date |
max_end_date (anyOf 2) | null | Alternative | |
max_last_date_to_terminate | JSON | Optional | |
max_last_date_to_terminate (anyOf 1) | string | Alternative | Filter by agreements whose last date to terminate is on or before the provided date. Default: null Format: date |
max_last_date_to_terminate (anyOf 2) | null | Alternative | |
max_start_date | JSON | Optional | |
max_start_date (anyOf 1) | string | Alternative | Filter by agreements whose start date is on or before the provided date. Default: null Format: date |
max_start_date (anyOf 2) | null | Alternative | |
max_total_value | JSON | Optional | |
max_total_value (anyOf 1) | JSON | Alternative | Filter by agreements with total value less than or equal to this value. Default: null |
max_total_value (anyOf 1) (oneOf 1) | string | Alternative | Format: decimal |
max_total_value (anyOf 1) (oneOf 2) | number | Alternative | |
max_total_value (anyOf 2) | null | Alternative | |
min_days_remaining | JSON | Optional | |
min_days_remaining (anyOf 1) | integer | Alternative | Filter by agreements with days remaining greater than or equal to this value. Default: null |
min_days_remaining (anyOf 2) | null | Alternative | |
min_end_date | JSON | Optional | |
min_end_date (anyOf 1) | string | Alternative | Filter by agreements whose end date is on or after the provided date. Default: null Format: date |
min_end_date (anyOf 2) | null | Alternative | |
min_last_date_to_terminate | JSON | Optional | |
min_last_date_to_terminate (anyOf 1) | string | Alternative | Filter by agreements whose last date to terminate is on or after the provided date. Default: null Format: date |
min_last_date_to_terminate (anyOf 2) | null | Alternative | |
min_start_date | JSON | Optional | |
min_start_date (anyOf 1) | string | Alternative | Filter by agreements whose start date is on or after the provided date. Default: null Format: date |
min_start_date (anyOf 2) | null | Alternative | |
min_total_value | JSON | Optional | |
min_total_value (anyOf 1) | JSON | Alternative | Filter by agreements with total value greater than or equal to this value. Default: null |
min_total_value (anyOf 1) (oneOf 1) | string | Alternative | Format: decimal |
min_total_value (anyOf 1) (oneOf 2) | number | Alternative | |
min_total_value (anyOf 2) | null | Alternative | |
page_size | integer | Optional | The number of results to be returned in each page. The value must be between 2 and 100. If not specified, the default value 20 will be used. Default: 20 |
payee_agreement_ids | JSON | Optional | |
payee_agreement_ids (anyOf 1) | array | Alternative | Filter by agreement IDs. |
payee_agreement_ids (anyOf 1)[] | string | Each item | Format: uuid |
payee_agreement_ids (anyOf 2) | null | Alternative | |
payee_ids | JSON | Optional | |
payee_ids (anyOf 1) | array | Alternative | Filter by vendor (payee) IDs. |
payee_ids (anyOf 1)[] | string | Each item | Format: uuid |
payee_ids (anyOf 2) | null | Alternative | |
payee_owner_ids | JSON | Optional | |
payee_owner_ids (anyOf 1) | array | Alternative | Filter by vendor owner IDs. |
payee_owner_ids (anyOf 1)[] | string | Each item | Format: uuid |
payee_owner_ids (anyOf 2) | null | Alternative | |
renewal_status | JSON | Optional | |
renewal_status (anyOf 1) | array | Alternative | Filter by agreement renewal status. |
renewal_status (anyOf 1)[] | string | Each item | One of: CANCELLED, EVALUATING, EXPIRED, INITIATED, NOT_STARTED, PLANNING, REJECTED, RENEWED, TERMINATED |
renewal_status (anyOf 2) | null | Alternative | |
renewal_status_exclude | JSON | Optional | |
renewal_status_exclude (anyOf 1) | array | Alternative | Exclude agreements with these renewal statuses. |
renewal_status_exclude (anyOf 1)[] | string | Each item | One of: CANCELLED, EVALUATING, EXPIRED, INITIATED, NOT_STARTED, PLANNING, REJECTED, RENEWED, TERMINATED |
renewal_status_exclude (anyOf 2) | null | Alternative | |
start | string | Optional | The ID of the last entity of the previous page, used for pagination to get the next page. |
start_date_range | JSON | Optional | |
start_date_range (anyOf 1) | Model | Alternative | Expand List vendor agreements — request body — body end date range end, start JSON object describing a relative start date range filter. |
start_date_range (anyOf 2) | null | Alternative |
Referenced models: List vendor agreements — request body — body agreement custom records type and, List vendor agreements — request body — body end date range end, start
List vendor agreements — request body — body agreement custom records type and
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
filters | array | Required within parent | |
filters[] | JSON | Each item | discriminator: {"mapping": {"and": "#/components/schemas/CustomRecordsQueryAndClauseRequestBody", "filter": "#/components/schemas/RowQueryFilterRequestBody", "or": "#/components/schemas/CustomRecordsQueryOrClauseRequestBody"}, "propertyName": "type"} |
filters[] (oneOf 1) | Model | Alternative | Expand List vendor agreements — request body — body agreement custom records type and |
filters[] (oneOf 2) | Model | Alternative | Expand List vendor agreements — request body — body agreement custom records type and filters item type or |
filters[] (oneOf 3) | Model | Alternative | Expand List vendor agreements — request body — body agreement custom records type and filters item type filter |
type | string | Optional | Must 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
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
type | string | Optional | Must equal: greater_than |
value | JSON | Required within parent | |
value (oneOf 1) | string | Alternative | Format: date-time |
value (oneOf 2) | number | Alternative | |
value (oneOf 3) | string | Alternative |
List vendor agreements — request body — body agreement custom records type and filters item type filter clause type greater than or equal
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
type | string | Optional | Must equal: greater_than_or_equal |
value | JSON | Required within parent | |
value (oneOf 1) | string | Alternative | Format: date-time |
value (oneOf 2) | number | Alternative | |
value (oneOf 3) | string | Alternative |
List vendor agreements — request body — body agreement custom records type and filters item type filter clause type is not
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
type | string | Optional | Must equal: is_not |
values | JSON | Required within parent | |
values (oneOf 1) | array | Alternative | |
values (oneOf 1)[] | string | Each item | Format: date-time |
values (oneOf 2) | array | Alternative | |
values (oneOf 2)[] | JSON | Each item | |
values (oneOf 2)[] (oneOf 1) | number | Alternative | |
values (oneOf 2)[] (oneOf 2) | string | Alternative | |
values (oneOf 3) | array | Alternative | |
values (oneOf 3)[] | boolean | Each item | |
values (oneOf 4) | array | Alternative | |
values (oneOf 4)[] | string | Each item |
List vendor agreements — request body — body agreement custom records type and filters item type filter clause type is not null
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
type | string | Optional | Must equal: is_not_null |
List vendor agreements — request body — body agreement custom records type and filters item type filter clause type is null
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
type | string | Optional | Must equal: is_null |
List vendor agreements — request body — body agreement custom records type and filters item type filter clause type less than
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
type | string | Optional | Must equal: less_than |
value | JSON | Required within parent | |
value (oneOf 1) | string | Alternative | Format: date-time |
value (oneOf 2) | number | Alternative | |
value (oneOf 3) | string | Alternative |
List vendor agreements — request body — body agreement custom records type and filters item type filter clause type less than or equal
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
type | string | Optional | Must equal: less_than_or_equal |
value | JSON | Required within parent | |
value (oneOf 1) | string | Alternative | Format: date-time |
value (oneOf 2) | number | Alternative | |
value (oneOf 3) | string | Alternative |
List vendor agreements — request body — body agreement custom records type and filters item type filter clause type one of
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
type | string | Optional | Must equal: one_of |
values | JSON | Required within parent | |
values (oneOf 1) | array | Alternative | |
values (oneOf 1)[] | string | Each item | Format: date-time |
values (oneOf 2) | array | Alternative | |
values (oneOf 2)[] | JSON | Each item | |
values (oneOf 2)[] (oneOf 1) | number | Alternative | |
values (oneOf 2)[] (oneOf 2) | string | Alternative | |
values (oneOf 3) | array | Alternative | |
values (oneOf 3)[] | boolean | Each item | |
values (oneOf 4) | array | Alternative | |
values (oneOf 4)[] | string | Each item |
List vendor agreements — request body — body agreement custom records type and filters item type or
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
filters | array | Required within parent | |
filters[] | JSON | Each item | discriminator: {"mapping": {"and": "#/components/schemas/CustomRecordsQueryAndClauseRequestBody", "filter": "#/components/schemas/RowQueryFilterRequestBody", "or": "#/components/schemas/CustomRecordsQueryOrClauseRequestBody"}, "propertyName": "type"} |
filters[] (oneOf 1) | Model | Alternative | Expand List vendor agreements — request body — body agreement custom records type and |
filters[] (oneOf 2) | Model | Alternative | Expand List vendor agreements — request body — body agreement custom records type and filters item type or |
filters[] (oneOf 3) | Model | Alternative | Expand List vendor agreements — request body — body agreement custom records type and filters item type filter |
type | string | Optional | Must 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Concrete relative date range for agreement date filters. |
end | Model | Optional | Expand List vendor agreements — request body — body end date range end, start end End date offset, always snapped to end of period |
start | Model | Optional | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents 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) |
offset | integer | Required within parent | Number of units to offset. Negative for past, positive for future. Example: -1 month = previous month |
unit | string | Required within parent | Units 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | Resources returned in this page. |
data[] | Model | Each item | Expand List vendor agreements — response body — data item |
page | Model | Required within parent | Expand List bills — response body — page Pagination details for this response. |
Referenced models: List bills — response body — page, List vendor agreements — response body — data item
List vendor agreements — response body — data / item / latest_renewal_request / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
currency | string | Required within parent | |
id | string | Required within parent | Format: uuid |
name | JSON | Optional | |
name (anyOf 1) | string | Alternative | |
name (anyOf 2) | null | Alternative | |
request_status | string | Required within parent | Known values: APPROVED, DRAFT, REJECTED, SUBMITTED |
submitted_at | JSON | Optional | |
submitted_at (anyOf 1) | string | Alternative | Format: date-time |
submitted_at (anyOf 2) | null | Alternative | |
total_amount | JSON | Optional | |
total_amount (anyOf 1) | Model | Alternative | Expand Hold Bill — response body — amount |
total_amount (anyOf 2) | null | Alternative | |
unified_request_id | string | Required within parent | Format: uuid |
user_full_name | string | Required within parent |
Referenced models: Hold Bill — response body — amount
List vendor agreements — response body — data item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
auto_renewal | boolean | Required within parent | |
available_actions | object | Required within parent | |
contract_owners | array | Required within parent | |
contract_owners[] | Model | Each item | Expand Fetch a vendor agreement — response body — contract owners item |
created_at | string | Required within parent | Format: date-time |
currency | string | Required within parent | |
custom_record_field_values | array | Required within parent | |
custom_record_field_values[] | Model | Each item | Expand Get a business entity — response body — custom record fields item |
days_remaining | Model | Required within parent | Expand Fetch a vendor agreement — response body — days remaining |
deleted_at | JSON | Optional | |
deleted_at (anyOf 1) | string | Alternative | Format: date-time |
deleted_at (anyOf 2) | null | Alternative | |
department | JSON | Optional | |
department (anyOf 1) | Model | Alternative | Expand List vendor agreements — response body — data item department id, name |
department (anyOf 2) | null | Alternative | |
description | JSON | Optional | |
description (anyOf 1) | string | Alternative | |
description (anyOf 2) | null | Alternative | |
draft_spend_requests | array | Required within parent | |
draft_spend_requests[] | Model | Each item | Expand Fetch a vendor agreement — response body — draft spend requests item |
end_date | JSON | Optional | |
end_date (anyOf 1) | string | Alternative | Format: date |
end_date (anyOf 2) | null | Alternative | |
has_approved_renewal_request | boolean | Required within parent | |
id | string | Required within parent | Format: uuid |
is_snoozed | boolean | Required within parent | |
is_up_for_renewal | boolean | Required within parent | |
last_date_to_terminate | JSON | Optional | |
last_date_to_terminate (anyOf 1) | string | Alternative | Format: date |
last_date_to_terminate (anyOf 2) | null | Alternative | |
latest_renewal_request | JSON | Optional | |
latest_renewal_request (anyOf 1) | Model | Alternative | Expand List vendor agreements — response body — data / item / latest_renewal_request / request_status: APPROVED, DRAFT, REJECTED, SUBMITTED |
latest_renewal_request (anyOf 2) | null | Alternative | |
logo | JSON | Optional | |
logo (anyOf 1) | string | Alternative | |
logo (anyOf 2) | null | Alternative | |
name | string | Required within parent | |
notifications_on | boolean | Required within parent | |
payee_id | string | Required within parent | Format: uuid |
payee_name | string | Required within parent | |
renewal_status | string | Required within parent | Known values: CANCELLED, EVALUATING, EXPIRED, INITIATED, NOT_STARTED, PLANNING, REJECTED, RENEWED, TERMINATED |
start_date | JSON | Optional | |
start_date (anyOf 1) | string | Alternative | Format: date |
start_date (anyOf 2) | null | Alternative | |
total_value | Model | Required within parent | Expand Hold Bill — response body — amount |
updated_at | string | Required within parent | Format: date-time |
uploaded_by_user | JSON | Optional | |
uploaded_by_user (anyOf 1) | Model | Alternative | Expand 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) | null | Alternative | |
vendor_owners | array | Required within parent | |
vendor_owners[] | Model | Each item | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
id | string | Required within parent | Format: uuid |
name | string | Required within parent |
List vendor agreements — response body — data item uploaded by user email, first name, full name, id, last name, profile picture url
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
email | string | Required within parent | Email address of the user who uploaded the document. Format: email |
first_name | string | Required within parent | First name of the user who uploaded the document. |
full_name | string | Required within parent | Full name of the user who uploaded the document. |
id | string | Required within parent | Unique identifier of the user who uploaded the source document. Format: uuid |
last_name | string | Required within parent | Last name of the user who uploaded the document. |
profile_picture_url | JSON | Optional | |
profile_picture_url (anyOf 1) | string | Alternative | Profile picture URL of the user who uploaded the document. |
profile_picture_url (anyOf 2) | null | Alternative |
List vendor agreements — response body — data item vendor owners item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
first_name | string | Required within parent | |
full_name | string | Required within parent | |
id | string | Required within parent | Format: uuid |
last_name | string | Required within parent |
List vendor bank accounts — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | Resources returned in this page. |
data[] | Model | Each item | Expand Fetch a vendor bank account — response body |
page | Model | Required within parent | Expand List bills — response body — page Pagination details for this response. |
Referenced models: List bills — response body — page, Fetch a vendor bank account — response body
List vendor contacts for vendor — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | Resources returned in this page. |
data[] | Model | Each item | Expand Fetch a vendor contact — response body |
page | Model | Required within parent | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
entity_id | JSON | Optional | |
entity_id (anyOf 1) | string | Alternative | Default: null Format: uuid |
entity_id (anyOf 2) | null | Alternative | |
from_created_at | JSON | Optional | |
from_created_at (anyOf 1) | string | Alternative | Default: null Format: date-time |
from_created_at (anyOf 2) | null | Alternative | |
to_created_at | JSON | Optional | |
to_created_at (anyOf 1) | string | Alternative | Default: null Format: date-time |
to_created_at (anyOf 2) | null | Alternative | |
from_accounting_date | JSON | Optional | |
from_accounting_date (anyOf 1) | string | Alternative | Default: null Format: date |
from_accounting_date (anyOf 2) | null | Alternative | |
to_accounting_date | JSON | Optional | |
to_accounting_date (anyOf 1) | string | Alternative | Default: null Format: date |
to_accounting_date (anyOf 2) | null | Alternative | |
include_fully_used | boolean | Optional | Default: false |
is_archived | boolean | Optional | Default: false |
start | string | Optional | |
page_size | integer | Optional | Default: 20 |
List vendor credits by vendor — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | Resources returned in this page. |
data[] | array | Each item | |
data[][] | Model | Each item | Expand Fetch a vendor credit — response body |
page | Model | Required within parent | Expand List bills — response body — page Pagination details for this response. |
Referenced models: List bills — response body — page, Fetch a vendor credit — response body
Place a hold on a vendor — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
reason | JSON | Optional | |
reason (anyOf 1) | string | Alternative | Optional reason for placing the vendor on hold. Default: null |
reason (anyOf 2) | null | Alternative |
Unlink purchase orders or documents from a vendor agreement — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
documents | array | Optional | Existing documents to unlink from the agreement. |
documents[] | Model | Each item | Expand Link purchase orders or documents to a vendor agreement — request body — body documents item |
purchase_order_ids | array | Optional | Unique identifiers of purchase orders to unlink from the agreement. |
purchase_order_ids[] | string | Each 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
agreement | Model | Required within parent | Expand Fetch a vendor agreement — response body |
number_of_documents_unlinked | JSON | Required within parent | |
number_of_documents_unlinked (anyOf 1) | integer | Alternative | Number of documents unlinked from the agreement. |
number_of_documents_unlinked (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
number_of_purchase_orders_unlinked | JSON | Required within parent | |
number_of_purchase_orders_unlinked (anyOf 1) | integer | Alternative | Number of purchase orders unlinked from the agreement. |
number_of_purchase_orders_unlinked (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Referenced models: Fetch a vendor agreement — response body
Update a vendor agreement — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
auto_renewal | boolean | Optional | Whether the agreement automatically renews. |
contract_owner_ids | array | Optional | List of contract owner user IDs. |
contract_owner_ids[] | string | Each item | Format: uuid |
description | JSON | Optional | |
description (anyOf 1) | string | Alternative | Description of the vendor agreement. |
description (anyOf 2) | null | Alternative | |
end_date | JSON | Optional | |
end_date (anyOf 1) | string | Alternative | End date of the agreement. Format: date |
end_date (anyOf 2) | null | Alternative | |
last_date_to_terminate | JSON | Optional | |
last_date_to_terminate (anyOf 1) | string | Alternative | Last date by which the agreement can be terminated. Format: date |
last_date_to_terminate (anyOf 2) | null | Alternative | |
name | string | Optional | Name of the vendor agreement. Minimum length: 1 |
notifications_on | boolean | Optional | Whether notifications are enabled for this agreement. |
renewal_action | Model | Optional | Expand 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_settings | JSON | Optional | |
renewal_notification_settings (anyOf 1) | Model | Alternative | Expand Create a vendor agreement — request body — body renewal notification settings notification triggers, recipient approval group uuids, recipient dynamic user group uuids, recipient user uuids, recurring settings, scheduled enabled, should notify contract owner managers Notification settings to apply to this agreement. |
renewal_notification_settings (anyOf 2) | null | Alternative | |
renewal_notification_snooze | JSON | Optional | |
renewal_notification_snooze (anyOf 1) | Model | Alternative | Expand 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) | null | Alternative | |
renewal_notification_snoozed_until | JSON | Optional | |
renewal_notification_snoozed_until (anyOf 1) | string | Alternative | Date 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) | null | Alternative | |
start_date | string | Optional | Start date of the agreement. Format: date |
total_value | Model | Optional | Expand Create a vendor agreement — request body — body total value Total monetary value of the agreement. |
Referenced models: Create a vendor agreement — request body — body total value, Create a vendor agreement — request body — body 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | discriminator: {"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) | Model | Alternative | Expand Update a vendor agreement — request body — body renewal action type NOT STARTED |
$ (oneOf 2) | Model | Alternative | Expand Update a vendor agreement — request body — body renewal action type CANCELLED |
$ (oneOf 3) | Model | Alternative | Expand Update a vendor agreement — request body — body renewal action type EVALUATING |
$ (oneOf 4) | Model | Alternative | Expand Update a vendor agreement — request body — body renewal action type PLANNING |
$ (oneOf 5) | Model | Alternative | Expand Update a vendor agreement — request body — body renewal action type RENEWED |
$ (oneOf 6) | Model | Alternative | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
mark_vendor_inactive | boolean | Optional | Default: false |
reason | string | Required within parent | |
type | string | Optional | Marks the agreement as not renewing. Must equal: CANCELLED |
Update a vendor agreement — request body — body renewal action type EVALUATING
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
type | string | Optional | Marks 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
type | string | Optional | Sets the agreement back to active. Must equal: NOT_STARTED |
Update a vendor agreement — request body — body renewal action type PLANNING
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
type | string | Optional | Marks 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
reason | string | Required within parent | |
type | string | Optional | Marks the agreement as renewed. Must equal: RENEWED |
Update a vendor agreement — request body — body renewal action type TERMINATED
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
type | string | Optional | Marks the agreement as terminated. Must equal: TERMINATED |
Update a vendor agreement — request body — body renewal notification snooze value
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | discriminator: {"mapping": {"DAYS": "#/components/schemas/RenewalNotificationSnoozeDaysRequestBody", "MONTHS": "#/components/schemas/RenewalNotificationSnoozeMonthsRequestBody", "WEEKS": "#/components/schemas/RenewalNotificationSnoozeWeeksRequestBody"}, "propertyName": "unit"} |
$ (oneOf 1) | Model | Alternative | Expand Update a vendor agreement — request body — body renewal notification snooze value unit DAYS |
$ (oneOf 2) | Model | Alternative | Expand Update a vendor agreement — request body — body renewal notification snooze value unit MONTHS |
$ (oneOf 3) | Model | Alternative | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Snooze renewal notifications for a number of days. |
duration | integer | Required within parent | Number of days to snooze (1-365) Maximum: 365 Minimum: 1 |
unit | string | Optional | Must equal: DAYS |
Update a vendor agreement — request body — body renewal notification snooze value unit MONTHS
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Snooze renewal notifications for a number of months. |
duration | integer | Required within parent | Number of months to snooze (1-12) Maximum: 12 Minimum: 1 |
unit | string | Optional | Must equal: MONTHS |
Update a vendor agreement — request body — body renewal notification snooze value unit WEEKS
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Snooze renewal notifications for a number of weeks. |
duration | integer | Required within parent | Number of weeks to snooze (1-52) Maximum: 52 Minimum: 1 |
unit | string | Optional | Must equal: WEEKS |
Update a vendor — vendor patch Vendor Resource — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
accounting_vendor_remote_id | string | Optional | The accounting remote id of the vendor. At most one of `accounting_vendor_remote_id` or `vendor_tracking_category_option_id` should be provided. |
address | Model | Optional | Expand Create a new vendor — request body — body address The address of the vendor. |
country | string | Optional | The country of the vendor. |
default_bank_account_id | string | Optional | Unique 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_id | JSON | Optional | |
default_entity_id (anyOf 1) | string | Alternative | Unique identifier of the default business entity to associate with this vendor. Must belong to the current business. Set to null to clear the default entity. Format: uuid |
default_entity_id (anyOf 2) | null | Alternative | |
description | string | Optional | Description of the vendor. |
display_name | string | Optional | Display name of the vendor. An empty string clears it. |
external_vendor_id | JSON | Optional | |
external_vendor_id (anyOf 1) | string | Alternative | Customer-defined external identifier for the vendor. This is independent of accounting system remote IDs. |
external_vendor_id (anyOf 2) | null | Alternative | |
is_active | boolean | Optional | Whether this vendor is active. |
name | string | Optional | Name of the vendor. Minimum length: 1 |
net_payment_terms | JSON | Optional | |
net_payment_terms (anyOf 1) | integer | Alternative | Number of days after receipt that payment is due. 0 means due on receipt; null clears the terms. Omit to leave unchanged. Maximum: 3652058 Minimum: 0 |
net_payment_terms (anyOf 2) | null | Alternative | |
request_payment_details | boolean | Optional | Whether to request payment details from the vendor (ACH bank account, international wire transfer, and check mailing address). Requires an existing default vendor contact email. Default: false |
request_tax_details | boolean | Optional | Whether to request tax information from the vendor (Tax Identification Number, federal tax classification, and tax address). Requires an existing default vendor contact email. Default: false |
state | JSON | Optional | |
state (anyOf 1) | string | Alternative | Vendor-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) | null | Alternative | |
vendor_tracking_category_option_id | string | Optional | Unique 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
batch_id | string | Required within parent | Identifier for the created document batch. |
document_count | JSON | Required within parent | |
document_count (anyOf 1) | integer | Alternative | Number of uploaded documents accepted for processing. |
document_count (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
job_id | string | Required within parent | Async job identifier for the upload batch. |