Skip to content

Ramp: Custom form schemas (part 1)

85 Ramp schemas with complete fields and constraints.

← Custom form operations Β· All schemas

Fetch a custom form collection response by ID β€” response body

FieldTypePresenceDescription and constraints
$objectRoot
custom_form_collection_responseModelRequired within parentExpand Fetch a custom form collection response by ID β€” response body β€” custom form collection response
The custom form collection with response data.
idstringRequired within parentUnique identifier of the custom form collection response.
Format: uuid

Referenced models: Fetch a custom form collection response by ID β€” response body β€” custom form collection response

Fetch a custom form collection response by ID β€” response body β€” custom form collection response

FieldTypePresenceDescription and constraints
$objectRoot
custom_form_collection_log_entryJSONRequired within parent
custom_form_collection_log_entry (anyOf 1)ModelAlternativeExpand Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label
Log entry for response to a custom form collection.
custom_form_collection_log_entry (anyOf 2)nullAlternative

Referenced models: Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label

Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label

FieldTypePresenceDescription and constraints
$objectRoot
allow_commentsbooleanRequired within parentWhether comments are allowed on field responses.
formsarrayRequired within parentThe custom forms and responses associated with the response log entry.
forms[]ModelEach itemExpand Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item
labelJSONRequired within parent
label (anyOf 1)stringAlternativeThe label for the response log entry.
label (anyOf 2)nullAlternative

Referenced models: Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item

Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item

FieldTypePresenceDescription and constraints
$objectRoot
fieldsarrayRequired within parentThe fields for the custom form responses.
fields[]ModelEach itemExpand Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item
labelJSONRequired within parent
label (anyOf 1)stringAlternativeThe label for the custom form.
label (anyOf 2)nullAlternative

Referenced models: Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item

Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item

FieldTypePresenceDescription and constraints
$objectRoot
allowed_dynamic_user_group_uuidsJSONOptional
allowed_dynamic_user_group_uuids (anyOf 1)arrayAlternativeDynamic user groups whose members may be selected for this field.
Default: null
allowed_dynamic_user_group_uuids (anyOf 1)[]stringEach item
allowed_dynamic_user_group_uuids (anyOf 2)nullAlternative
allowed_usersJSONOptional
allowed_users (anyOf 1)arrayAlternativeEligible users resolved for this form. Null applies no additional restriction; an empty list means no eligible users.
Default: null
allowed_users (anyOf 1)[]ModelEach itemExpand Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item allowed users array item
allowed_users (anyOf 2)nullAlternative
approval_workflow_referencesJSONOptional
approval_workflow_references (anyOf 1)arrayAlternativeApproval workflow dependencies; absent or null when unavailable, otherwise complete.
Default: null
approval_workflow_references (anyOf 1)[]ModelEach itemExpand Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item approval workflow references array item
approval_workflow_references (anyOf 2)nullAlternative
attachmentsarrayOptional
attachments[]ModelEach itemExpand Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item attachments item
conditionsJSONRequired within parent
conditions (anyOf 1)ModelAlternativeExpand Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item conditions condition, then
conditions (anyOf 2)nullAlternative
descriptionJSONRequired within parent
description (anyOf 1)stringAlternative
description (anyOf 2)nullAlternative
exclude_from_ai_prefillbooleanOptionalWhen True, AI intake/document prefill never generates an answer for this field.
Default: false
fieldModelRequired within parentExpand Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field
field_idstringRequired within parent
field_mapping_referencesarrayOptionalIntegration field mappings that reference this question.
field_mapping_references[]ModelEach itemExpand Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field mapping references item
global_library_field_idJSONOptional
global_library_field_id (anyOf 1)stringAlternativeDefault: null
global_library_field_id (anyOf 2)nullAlternative
is_mapped_to_ironclad_fieldbooleanOptionalDefault: false
is_used_in_approval_workflow_approval_stepbooleanOptionalWhether an approval step selects its approver from this field.
Default: false
is_used_in_approval_workflow_conditionbooleanOptionalBroad compatibility flag for fields used in approval conditions or approval steps.
Default: false
is_used_in_custom_form_workflow_conditionbooleanOptionalDefault: false
labelstringRequired within parent
requiredbooleanRequired within parent
required_if_conditionsJSONOptional
required_if_conditions (anyOf 1)ModelAlternativeExpand Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item conditions condition, then
Conditions that make this field required when they evaluate to true.
Default: null
required_if_conditions (anyOf 2)nullAlternative
short_titleJSONOptional
short_title (anyOf 1)stringAlternativeOptional concise title copied from a Global Question Library field.
Default: null
short_title (anyOf 2)nullAlternative
validation_errorsarrayOptional
validation_errors[]ModelEach itemExpand Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item validation errors item
value_display_stringJSONRequired within parent
value_display_string (anyOf 1)stringAlternativeRead only: true
value_display_string (anyOf 2)nullAlternative

Referenced models: Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item validation errors item, Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item conditions condition, then, Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field, Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item approval workflow references array item, Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field mapping references item, Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item attachments item, Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item allowed users array item

Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item allowed users array item

FieldTypePresenceDescription and constraints
$objectRoot
emailstringRequired within parentEmail address of the selected user.
first_namestringRequired within parentFirst name of the selected user.
last_namestringRequired within parentLast name of the selected user.
user_uuidstringRequired within parentUUID of the selected user.

Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item approval workflow references array item

FieldTypePresenceDescription and constraints
$objectRoot
branch_idJSONOptional
branch_id (anyOf 1)stringAlternativeCondition branch identifier, when available.
Default: null
branch_id (anyOf 2)nullAlternative
branch_indexJSONOptional
branch_index (anyOf 1)JSONAlternative
branch_index (anyOf 1) (anyOf 1)integerAlternativeCondition branch position for historical fallback.
Default: null
branch_index (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
branch_index (anyOf 2)nullAlternative
kindstringRequired within parentWhether the question is used by a condition or approval step.
Known values: APPROVAL_STEP, CONDITION
labelJSONOptional
label (anyOf 1)stringAlternativeBranch or approval step label; null when unnamed.
Default: null
label (anyOf 2)nullAlternative
node_idstringRequired within parentReferencing workflow graph node identifier.
referenced_choice_labelsarrayOptionalChoice labels referenced by the condition.
referenced_choice_labels[]stringEach item
template_idstringRequired within parentExact workflow template version inspected.
Format: uuid
workflow_idstringRequired within parentWorkflow containing the reference.
Format: uuid

Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item attachments item

FieldTypePresenceDescription and constraints
$objectRootPublic-facing dump of a RampDocument container plus its latest version.
created_atstringRequired within parentFormat: date-time
idstringRequired within parent
latest_versionModelRequired within parentExpand Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item attachments item latest version
version_countJSONRequired within parent
version_count (anyOf 1)integerAlternative
version_count (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
version_typestringRequired within parentKnown values: GENERIC, PAYEE, PROCUREMENT, TAX_EXEMPTION_CERTIFICATE, WBX

Referenced models: Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item attachments item latest version

Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item attachments item latest version

FieldTypePresenceDescription and constraints
$objectRootBase fields for any ramp document version.
cloudfront_download_urlstringRequired within parent
cloudfront_urlstringRequired within parent
created_atstringRequired within parentFormat: date-time
idstringRequired within parent
original_filenamestringRequired within parent
version_numberJSONRequired within parent
version_number (anyOf 1)integerAlternative
version_number (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item conditions condition, then

FieldTypePresenceDescription and constraints
$objectRoot
conditionModelRequired within parentExpand Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item conditions condition, then condition
thenarrayRequired within parent
then[]ModelEach itemExpand Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item conditions condition, then then item

Referenced models: Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item conditions condition, then condition, Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item conditions condition, then then item

Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item conditions condition, then condition

FieldTypePresenceDescription and constraints
$objectRoot
itemsarrayRequired within parent
items[]ModelEach itemExpand Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item conditions condition, then condition items item
operatorstringRequired within parentKnown values: ALL, ANY, NOT

Referenced models: Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item conditions condition, then condition items item

Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item conditions condition, then condition items item

FieldTypePresenceDescription and constraints
$JSONRootdiscriminator: {"mapping": {"CONDITION": "#/components/schemas/AtomicCondition", "CONDITION_GROUP": "#/components/schemas/NestedConditionGroup"}, "propertyName": "condition_item_type"}
$ (anyOf 1)ModelAlternativeExpand Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item conditions condition, then condition items item condition item type CONDITION
$ (anyOf 2)ModelAlternativeExpand Fetch a custom form collection response by ID β€” response body β€” custom_form_collection_response / custom_form_collection_log_entry / allow_comments, forms, label / forms / item / fields / item / conditions / condition, then / condition / items / item / condition_item_type CONDITION_GROUP, operator: ALL, ANY, NOT

Referenced models: Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item conditions condition, then condition items item condition item type CONDITION, Fetch a custom form collection response by ID β€” response body β€” custom_form_collection_response / custom_form_collection_log_entry / allow_comments, forms, label / forms / item / fields / item / conditions / condition, then / condition / items / item / condition_item_type CONDITION_GROUP, operator: ALL, ANY, NOT

Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item conditions condition, then condition items item condition item type CONDITION

FieldTypePresenceDescription and constraints
$objectRoot
condition_item_typestringRequired within parentMust equal: CONDITION
currencyJSONOptional
currency (anyOf 1)stringAlternativeThreshold currency of a money condition. Missing or null means USD.
currency (anyOf 2)nullAlternative
left_operandModelRequired within parentExpand Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item conditions condition, then condition items item condition item type CONDITION left operand
operatorModelRequired within parentExpand Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item conditions condition, then condition items item condition item type CONDITION operator
right_operandModelRequired within parentExpand Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item conditions condition, then condition items item condition item type CONDITION left operand

Referenced models: Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item conditions condition, then condition items item condition item type CONDITION operator, Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item conditions condition, then condition items item condition item type CONDITION left operand

Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item conditions condition, then condition items item condition item type CONDITION left operand

FieldTypePresenceDescription and constraints
$JSONRootdiscriminator: {"mapping": {"OBJECT": "#/components/schemas/ObjectValuePoly", "OBJECT_LIST": "#/components/schemas/PolyObjectValuePoly", "STATE_OBJECT_LIST_REFERENCE": "#/components/schemas/StateObjectListReference", "STATE_OBJECT_REFERENCE": "#/components/schemas/StateObjectReference", "STATE_REFERENCE": "#/components/schemas/StateReference", "STATIC_VALUE": "#/components/schemas/StaticValue"}, "propertyName": "operand_type"}
$ (anyOf 1)ModelAlternativeExpand Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item conditions condition, then condition items item condition item type CONDITION left operand operand type OBJECT
$ (anyOf 2)ModelAlternativeExpand Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item conditions condition, then condition items item condition item type CONDITION left operand operand type OBJECT LIST
$ (anyOf 3)ModelAlternativeExpand Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item conditions condition, then condition items item condition item type CONDITION left operand operand type STATE OBJECT LIST REFERENCE
$ (anyOf 4)ModelAlternativeExpand Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item conditions condition, then condition items item condition item type CONDITION left operand operand type STATE OBJECT REFERENCE
$ (anyOf 5)ModelAlternativeExpand Fetch a custom form collection response by ID β€” response body β€” custom_form_collection_response / custom_form_collection_log_entry / allow_comments, forms, label / forms / item / fields / item / conditions / condition, then / condition / items / item / condition_item_type CONDITION / left_operand / operand_type STATE_REFERENCE, type: ARRAY, BOOL, INT, JSONB, NUMERIC, STR
$ (anyOf 6)ModelAlternativeExpand Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item conditions condition, then condition items item condition item type CONDITION left operand operand type STATIC VALUE

Referenced models: Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item conditions condition, then condition items item condition item type CONDITION left operand operand type OBJECT, Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item conditions condition, then condition items item condition item type CONDITION left operand operand type OBJECT LIST, Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item conditions condition, then condition items item condition item type CONDITION left operand operand type STATE OBJECT LIST REFERENCE, Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item conditions condition, then condition items item condition item type CONDITION left operand operand type STATE OBJECT REFERENCE, Fetch a custom form collection response by ID β€” response body β€” custom_form_collection_response / custom_form_collection_log_entry / allow_comments, forms, label / forms / item / fields / item / conditions / condition, then / condition / items / item / condition_item_type CONDITION / left_operand / operand_type STATE_REFERENCE, type: ARRAY, BOOL, INT, JSONB, NUMERIC, STR, Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item conditions condition, then condition items item condition item type CONDITION left operand operand type STATIC VALUE

Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item conditions condition, then condition items item condition item type CONDITION left operand operand type OBJECT

FieldTypePresenceDescription and constraints
$objectRoot
objectModelRequired within parentExpand Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item conditions condition, then condition items item condition item type CONDITION left operand operand type OBJECT object
object_typestringRequired within parent
operand_typestringRequired within parentMust equal: OBJECT

Referenced models: Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item conditions condition, then condition items item condition item type CONDITION left operand operand type OBJECT object

Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item conditions condition, then condition items item condition item type CONDITION left operand operand type OBJECT LIST

FieldTypePresenceDescription and constraints
$objectRoot
object_typestringRequired within parent
objectsarrayRequired within parent
objects[]ModelEach itemExpand Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item conditions condition, then condition items item condition item type CONDITION left operand operand type OBJECT object
operand_typestringRequired within parentMust equal: OBJECT_LIST

Referenced models: Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item conditions condition, then condition items item condition item type CONDITION left operand operand type OBJECT object

Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item conditions condition, then condition items item condition item type CONDITION left operand operand type OBJECT object

FieldTypePresenceDescription and constraints
$objectRoot
deletedbooleanOptionalRead only: true
display_namestringRequired within parentRead only: true
idJSONRequired within parent
id (anyOf 1)stringAlternative
id (anyOf 2)nullAlternative

Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item conditions condition, then condition items item condition item type CONDITION left operand operand type STATE OBJECT LIST REFERENCE

FieldTypePresenceDescription and constraints
$objectRoot
displaystringRequired within parentRead only: true
maskJSONOptional
mask (anyOf 1)stringAlternativeKnown values: CURRENCY, DAY, PERCENTAGE
Read only: true
mask (anyOf 2)nullAlternative
object_list_typestringRequired within parentRead only: true
operand_typestringRequired within parentMust equal: STATE_OBJECT_LIST_REFERENCE
variable_namestringRequired within parent

Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item conditions condition, then condition items item condition item type CONDITION left operand operand type STATE OBJECT REFERENCE

FieldTypePresenceDescription and constraints
$objectRoot
displaystringRequired within parentRead only: true
maskJSONOptional
mask (anyOf 1)stringAlternativeKnown values: CURRENCY, DAY, PERCENTAGE
Read only: true
mask (anyOf 2)nullAlternative
object_typestringRequired within parentRead only: true
operand_typestringRequired within parentMust equal: STATE_OBJECT_REFERENCE
variable_namestringRequired within parent

Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item conditions condition, then condition items item condition item type CONDITION left operand operand type STATIC VALUE

FieldTypePresenceDescription and constraints
$objectRoot
operand_typestringRequired within parentMust equal: STATIC_VALUE
valueModelRequired within parentExpand Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item conditions condition, then then item vertex type ACTION action kwargs item action kwarg type TYPED KEY VALUE PAIR value

Referenced models: Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item conditions condition, then then item vertex type ACTION action kwargs item action kwarg type TYPED KEY VALUE PAIR value

Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item conditions condition, then condition items item condition item type CONDITION operator

FieldTypePresenceDescription and constraints
$objectRoot
operatorstringRequired within parent
operator_displaystringRequired within parentRead only: true

Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item conditions condition, then then item

FieldTypePresenceDescription and constraints
$JSONRootdiscriminator: {"mapping": {"ACTION": "#/components/schemas/Action", "BLOCK_GROUP": "#/components/schemas/BlockGroup", "CONDITION": "#/components/schemas/ConditionVertex", "SDK_CONDITION": "#/components/schemas/SDKCondition"}, "propertyName": "vertex_type"}
$ (anyOf 1)ModelAlternativeExpand Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item conditions condition, then then item vertex type ACTION
$ (anyOf 2)ModelAlternativeExpand Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item conditions condition, then then item vertex type BLOCK GROUP
$ (anyOf 3)ModelAlternativeExpand Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item conditions condition, then then item vertex type CONDITION
$ (anyOf 4)ModelAlternativeExpand Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item conditions condition, then then item vertex type SDK CONDITION

Referenced models: Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item conditions condition, then then item vertex type ACTION, Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item conditions condition, then then item vertex type BLOCK GROUP, Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item conditions condition, then then item vertex type CONDITION, Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item conditions condition, then then item vertex type SDK CONDITION

Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item conditions condition, then then item vertex type ACTION

FieldTypePresenceDescription and constraints
$objectRoot
action_kwargsarrayRequired within parent
action_kwargs[]ModelEach itemExpand Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item conditions condition, then then item vertex type ACTION action kwargs item
available_operandsarrayOptionalRead only: true
available_operands[]ModelEach itemExpand Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item conditions condition, then then item vertex type ACTION available operands item
has_been_visitedbooleanOptionalRead only: true
identifierstringRequired within parent
metadataJSONOptional
uuidstringRequired within parentFormat: uuid
vertex_typestringRequired within parentMust equal: ACTION

Referenced models: Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item conditions condition, then then item vertex type ACTION action kwargs item, Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item conditions condition, then then item vertex type ACTION available operands item

Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item conditions condition, then then item vertex type ACTION action kwargs item

FieldTypePresenceDescription and constraints
$JSONRootdiscriminator: {"mapping": {"KEY_STATE_REFERENCE_TYPE": "#/components/schemas/KeyStateReference", "OBJECT": "#/components/schemas/ActionKwargObject", "OBJECT_LIST": "#/components/schemas/ActionKwargObjectList", "TYPED_KEY_VALUE_PAIR": "#/components/schemas/ActionKwargTypedKeyValuePair"}, "propertyName": "action_kwarg_type"}
$ (anyOf 1)ModelAlternativeExpand Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item conditions condition, then then item vertex type ACTION action kwargs item action kwarg type OBJECT
$ (anyOf 2)ModelAlternativeExpand Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item conditions condition, then then item vertex type ACTION action kwargs item action kwarg type OBJECT LIST
$ (anyOf 3)ModelAlternativeExpand Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item conditions condition, then then item vertex type ACTION action kwargs item action kwarg type TYPED KEY VALUE PAIR
$ (anyOf 4)ModelAlternativeExpand Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item conditions condition, then then item vertex type ACTION action kwargs item action kwarg type KEY STATE REFERENCE TYPE

Referenced models: Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item conditions condition, then then item vertex type ACTION action kwargs item action kwarg type OBJECT, Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item conditions condition, then then item vertex type ACTION action kwargs item action kwarg type OBJECT LIST, Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item conditions condition, then then item vertex type ACTION action kwargs item action kwarg type KEY STATE REFERENCE TYPE, Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item conditions condition, then then item vertex type ACTION action kwargs item action kwarg type TYPED KEY VALUE PAIR

Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item conditions condition, then then item vertex type ACTION action kwargs item action kwarg type KEY STATE REFERENCE TYPE

FieldTypePresenceDescription and constraints
$objectRoot
action_kwarg_typestringRequired within parentMust equal: KEY_STATE_REFERENCE_TYPE
keystringRequired within parent
variable_namestringRequired within parent

Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item conditions condition, then then item vertex type ACTION action kwargs item action kwarg type OBJECT

FieldTypePresenceDescription and constraints
$objectRoot
action_kwarg_typestringRequired within parentMust equal: OBJECT
keystringRequired within parent
objectJSONRequired within parent
object (anyOf 1)ModelAlternativeExpand Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item conditions condition, then condition items item condition item type CONDITION left operand operand type OBJECT object
object (anyOf 2)nullAlternative
object_typestringRequired within parent

Referenced models: Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item conditions condition, then condition items item condition item type CONDITION left operand operand type OBJECT object

Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item conditions condition, then then item vertex type ACTION action kwargs item action kwarg type OBJECT LIST

FieldTypePresenceDescription and constraints
$objectRoot
action_kwarg_typestringRequired within parentMust equal: OBJECT_LIST
keystringRequired within parent
object_typestringRequired within parent
objectsarrayRequired within parent
objects[]JSONEach item
objects[] (anyOf 1)ModelAlternativeExpand Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item conditions condition, then condition items item condition item type CONDITION left operand operand type OBJECT object
objects[] (anyOf 2)nullAlternative

Referenced models: Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item conditions condition, then condition items item condition item type CONDITION left operand operand type OBJECT object

Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item conditions condition, then then item vertex type ACTION action kwargs item action kwarg type TYPED KEY VALUE PAIR

FieldTypePresenceDescription and constraints
$objectRoot
action_kwarg_typestringRequired within parentMust equal: TYPED_KEY_VALUE_PAIR
keystringRequired within parent
valueModelRequired within parentExpand Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item conditions condition, then then item vertex type ACTION action kwargs item action kwarg type TYPED KEY VALUE PAIR value

Referenced models: Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item conditions condition, then then item vertex type ACTION action kwargs item action kwarg type TYPED KEY VALUE PAIR value

Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item conditions condition, then then item vertex type ACTION action kwargs item action kwarg type TYPED KEY VALUE PAIR value

FieldTypePresenceDescription and constraints
$JSONRootdiscriminator: {"mapping": {"ARRAY": "#/components/schemas/ArrayValue", "BOOL": "#/components/schemas/BoolValue", "INT": "#/components/schemas/IntValue", "JSONB": "#/components/schemas/JSONBValue", "NUMERIC": "#/components/schemas/NumericValue", "STR": "#/components/schemas/StrValue"}, "propertyName": "type"}
$ (anyOf 1)ModelAlternativeExpand Fetch a custom form collection response by ID β€” response body β€” custom_form_collection_response / custom_form_collection_log_entry / allow_comments, forms, label / forms / item / fields / item / conditions / condition, then / then / item / vertex_type ACTION / action_kwargs / item / action_kwarg_type TYPED_KEY_VALUE_PAIR / value / child_type: ARRAY, BOOL, INT, JSONB, NUMERIC, STR, type ARRAY
$ (anyOf 2)ModelAlternativeExpand Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item conditions condition, then then item vertex type ACTION action kwargs item action kwarg type TYPED KEY VALUE PAIR value type BOOL
$ (anyOf 3)ModelAlternativeExpand Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item conditions condition, then then item vertex type ACTION action kwargs item action kwarg type TYPED KEY VALUE PAIR value type INT
$ (anyOf 4)ModelAlternativeExpand Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item conditions condition, then then item vertex type ACTION action kwargs item action kwarg type TYPED KEY VALUE PAIR value type JSONB
$ (anyOf 5)ModelAlternativeExpand Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item conditions condition, then then item vertex type ACTION action kwargs item action kwarg type TYPED KEY VALUE PAIR value type NUMERIC
$ (anyOf 6)ModelAlternativeExpand Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item conditions condition, then then item vertex type ACTION action kwargs item action kwarg type TYPED KEY VALUE PAIR value type STR

Referenced models: Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item conditions condition, then then item vertex type ACTION action kwargs item action kwarg type TYPED KEY VALUE PAIR value type BOOL, Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item conditions condition, then then item vertex type ACTION action kwargs item action kwarg type TYPED KEY VALUE PAIR value type JSONB, Fetch a custom form collection response by ID β€” response body β€” custom_form_collection_response / custom_form_collection_log_entry / allow_comments, forms, label / forms / item / fields / item / conditions / condition, then / then / item / vertex_type ACTION / action_kwargs / item / action_kwarg_type TYPED_KEY_VALUE_PAIR / value / child_type: ARRAY, BOOL, INT, JSONB, NUMERIC, STR, type ARRAY, Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item conditions condition, then then item vertex type ACTION action kwargs item action kwarg type TYPED KEY VALUE PAIR value type INT, Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item conditions condition, then then item vertex type ACTION action kwargs item action kwarg type TYPED KEY VALUE PAIR value type NUMERIC, Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item conditions condition, then then item vertex type ACTION action kwargs item action kwarg type TYPED KEY VALUE PAIR value type STR

Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item conditions condition, then then item vertex type ACTION action kwargs item action kwarg type TYPED KEY VALUE PAIR value type BOOL

FieldTypePresenceDescription and constraints
$objectRoot
child_typeJSONOptional
child_type (anyOf 1)stringAlternative
child_type (anyOf 2)nullAlternative
typestringRequired within parentMust equal: BOOL
valueJSONOptional
value (anyOf 1)booleanAlternative
value (anyOf 2)nullAlternative

Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item conditions condition, then then item vertex type ACTION action kwargs item action kwarg type TYPED KEY VALUE PAIR value type INT

FieldTypePresenceDescription and constraints
$objectRoot
child_typeJSONOptional
child_type (anyOf 1)stringAlternative
child_type (anyOf 2)nullAlternative
typestringRequired within parentMust equal: INT
valueJSONOptional
value (anyOf 1)JSONAlternative
value (anyOf 1) (anyOf 1)integerAlternative
value (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
value (anyOf 2)nullAlternative

Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item conditions condition, then then item vertex type ACTION action kwargs item action kwarg type TYPED KEY VALUE PAIR value type JSONB

FieldTypePresenceDescription and constraints
$objectRoot
child_typeJSONOptional
child_type (anyOf 1)stringAlternative
child_type (anyOf 2)nullAlternative
typestringRequired within parentMust equal: JSONB
valueJSONOptional
value (anyOf 1)JSONAlternative
value (anyOf 2)nullAlternative

Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item conditions condition, then then item vertex type ACTION action kwargs item action kwarg type TYPED KEY VALUE PAIR value type NUMERIC

FieldTypePresenceDescription and constraints
$objectRoot
child_typeJSONOptional
child_type (anyOf 1)stringAlternative
child_type (anyOf 2)nullAlternative
typestringRequired within parentMust equal: NUMERIC
valueJSONOptional
value (anyOf 1)JSONAlternative
value (anyOf 1) (anyOf 1)numberAlternative
value (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
value (anyOf 2)nullAlternative

Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item conditions condition, then then item vertex type ACTION action kwargs item action kwarg type TYPED KEY VALUE PAIR value type STR

FieldTypePresenceDescription and constraints
$objectRoot
child_typeJSONOptional
child_type (anyOf 1)stringAlternative
child_type (anyOf 2)nullAlternative
typestringRequired within parentMust equal: STR
valueJSONOptional
value (anyOf 1)stringAlternative
value (anyOf 2)nullAlternative

Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item conditions condition, then then item vertex type ACTION available operands item

FieldTypePresenceDescription and constraints
$JSONRootdiscriminator: {"mapping": {"OBJECT": "#/components/schemas/AvailableOperandObjectType", "STATE": "#/components/schemas/AvailableState", "STATE_OBJECT": "#/components/schemas/AvailableStateObject", "STATE_OBJECT_LIST": "#/components/schemas/AvailableStateObjectList"}, "propertyName": "available_operand_type"}
$ (anyOf 1)ModelAlternativeExpand Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item conditions condition, then then item vertex type ACTION available operands item available operand type OBJECT
$ (anyOf 2)ModelAlternativeExpand Fetch a custom form collection response by ID β€” response body β€” custom_form_collection_response / custom_form_collection_log_entry / allow_comments, forms, label / forms / item / fields / item / conditions / condition, then / then / item / vertex_type ACTION / available_operands / item / available_operand_type STATE, state_type: CONSTANT, DYNAMIC, STATIC, type: ARRAY, BOOL, INT, JSONB, NUMERIC, STR
$ (anyOf 3)ModelAlternativeExpand Fetch a custom form collection response by ID β€” response body β€” custom_form_collection_response / custom_form_collection_log_entry / allow_comments, forms, label / forms / item / fields / item / conditions / condition, then / then / item / vertex_type ACTION / available_operands / item / available_operand_type STATE_OBJECT, state_type: CONSTANT, DYNAMIC, STATIC
$ (anyOf 4)ModelAlternativeExpand Fetch a custom form collection response by ID β€” response body β€” custom_form_collection_response / custom_form_collection_log_entry / allow_comments, forms, label / forms / item / fields / item / conditions / condition, then / then / item / vertex_type ACTION / available_operands / item / available_operand_type STATE_OBJECT_LIST, state_type: CONSTANT, DYNAMIC, STATIC

Referenced models: Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item conditions condition, then then item vertex type ACTION available operands item available operand type OBJECT, Fetch a custom form collection response by ID β€” response body β€” custom_form_collection_response / custom_form_collection_log_entry / allow_comments, forms, label / forms / item / fields / item / conditions / condition, then / then / item / vertex_type ACTION / available_operands / item / available_operand_type STATE, state_type: CONSTANT, DYNAMIC, STATIC, type: ARRAY, BOOL, INT, JSONB, NUMERIC, STR, Fetch a custom form collection response by ID β€” response body β€” custom_form_collection_response / custom_form_collection_log_entry / allow_comments, forms, label / forms / item / fields / item / conditions / condition, then / then / item / vertex_type ACTION / available_operands / item / available_operand_type STATE_OBJECT, state_type: CONSTANT, DYNAMIC, STATIC, Fetch a custom form collection response by ID β€” response body β€” custom_form_collection_response / custom_form_collection_log_entry / allow_comments, forms, label / forms / item / fields / item / conditions / condition, then / then / item / vertex_type ACTION / available_operands / item / available_operand_type STATE_OBJECT_LIST, state_type: CONSTANT, DYNAMIC, STATIC

Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item conditions condition, then then item vertex type ACTION available operands item available operand type OBJECT

FieldTypePresenceDescription and constraints
$objectRoot
available_operand_typestringRequired within parentMust equal: OBJECT
object_typestringRequired within parent

Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item conditions condition, then then item vertex type BLOCK GROUP

FieldTypePresenceDescription and constraints
$objectRoot
available_operandsarrayOptionalRead only: true
available_operands[]ModelEach itemExpand Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item conditions condition, then then item vertex type ACTION available operands item
has_been_visitedbooleanOptionalRead only: true
identifierJSONOptional
identifier (anyOf 1)stringAlternative
identifier (anyOf 2)nullAlternative
metadataJSONOptional
uuidstringRequired within parentFormat: uuid
vertex_typestringRequired within parentMust equal: BLOCK_GROUP

Referenced models: Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item conditions condition, then then item vertex type ACTION available operands item

Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item conditions condition, then then item vertex type CONDITION

FieldTypePresenceDescription and constraints
$objectRoot
available_operandsarrayOptionalRead only: true
available_operands[]ModelEach itemExpand Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item conditions condition, then then item vertex type ACTION available operands item
has_been_visitedbooleanOptionalRead only: true
identifierJSONOptional
identifier (anyOf 1)stringAlternative
identifier (anyOf 2)nullAlternative
metadataJSONOptional
uuidstringRequired within parentFormat: uuid
vertex_typestringRequired within parentMust equal: CONDITION

Referenced models: Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item conditions condition, then then item vertex type ACTION available operands item

Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item conditions condition, then then item vertex type SDK CONDITION

FieldTypePresenceDescription and constraints
$objectRoot
available_operandsarrayOptionalRead only: true
available_operands[]ModelEach itemExpand Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item conditions condition, then then item vertex type ACTION available operands item
conditionsarrayRequired within parent
conditions[]ModelEach itemExpand Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item conditions condition, then
else_blocksarrayRequired within parent
else_blocks[]ModelEach itemExpand Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item conditions condition, then then item
else_condition_groupJSONRequired within parent
else_condition_group (anyOf 1)ModelAlternativeExpand Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item conditions condition, then condition
Default: null
else_condition_group (anyOf 2)nullAlternative
has_been_visitedbooleanOptionalRead only: true
identifierJSONOptional
identifier (anyOf 1)stringAlternative
identifier (anyOf 2)nullAlternative
metadataJSONOptional
uuidstringRequired within parentFormat: uuid
vertex_typestringRequired within parentMust equal: SDK_CONDITION

Referenced models: Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item conditions condition, then then item vertex type ACTION available operands item, Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item conditions condition, then, Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item conditions condition, then condition, Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item conditions condition, then then item

Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field

FieldTypePresenceDescription and constraints
$JSONRootdiscriminator: {"mapping": {"ADDRESS": "#/components/schemas/CustomFormAddressFieldResponseDumpSchema", "BOOLEAN": "#/components/schemas/CustomFormBooleanFieldResponseDumpSchema", "CONTACT": "#/components/schemas/CustomFormContactFieldResponseDumpSchema", "DATE": "#/components/schemas/CustomFormDateFieldResponseDumpSchema", "DEPARTMENT": "#/components/schemas/CustomFormDepartmentFieldResponseDumpSchema", "EMAIL": "#/components/schemas/CustomFormEmailFieldResponseDumpSchema", "FILE_UPLOAD": "#/components/schemas/CustomFormFileUploadFieldResponseDumpSchema", "LINK": "#/components/schemas/CustomFormLinkFieldResponseDumpSchema", "MERCHANT": "#/components/schemas/CustomFormMerchantFieldResponseDumpSchema", "MERCHANT_CATEGORY": "#/components/schemas/CustomFormMerchantCategoryFieldResponseDumpSchema", "MONETARY_AMOUNT": "#/components/schemas/CustomFormMonetaryAmountFieldResponseDumpSchema", "NUMBER": "#/components/schemas/CustomFormNumberFieldResponseDumpSchema", "PARAGRAPH": "#/components/schemas/CustomFormParagraphFieldResponseDumpSchema", "TEXT": "#/components/schemas/CustomFormTextFieldResponseDumpSchema", "TEXT_MULTI_SELECT": "#/components/schemas/CustomFormTextMultiSelectFieldResponseDumpSchema", "TEXT_SINGLE_SELECT": "#/components/schemas/CustomFormTextSingleSelectFieldResponseDumpSchema", "USER": "#/components/schemas/CustomFormUserFieldResponseDumpSchema", "VENDOR": "#/components/schemas/CustomFormVendorFieldResponseDumpSchema"}, "propertyName": "field_type"}
$ (anyOf 1)ModelAlternativeExpand Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type ADDRESS
$ (anyOf 2)ModelAlternativeExpand Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type BOOLEAN
$ (anyOf 3)ModelAlternativeExpand Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type CONTACT
$ (anyOf 4)ModelAlternativeExpand Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type DATE
$ (anyOf 5)ModelAlternativeExpand Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type DEPARTMENT
$ (anyOf 6)ModelAlternativeExpand Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type EMAIL
$ (anyOf 7)ModelAlternativeExpand Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type FILE UPLOAD
$ (anyOf 8)ModelAlternativeExpand Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type LINK
$ (anyOf 9)ModelAlternativeExpand Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type MERCHANT CATEGORY
$ (anyOf 10)ModelAlternativeExpand Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type MERCHANT
$ (anyOf 11)ModelAlternativeExpand Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type MONETARY AMOUNT
$ (anyOf 12)ModelAlternativeExpand Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type NUMBER
$ (anyOf 13)ModelAlternativeExpand Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type PARAGRAPH
$ (anyOf 14)ModelAlternativeExpand Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type TEXT
$ (anyOf 15)ModelAlternativeExpand Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type TEXT MULTI SELECT
$ (anyOf 16)ModelAlternativeExpand Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type TEXT SINGLE SELECT
$ (anyOf 17)ModelAlternativeExpand Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type USER
$ (anyOf 18)ModelAlternativeExpand Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type VENDOR

Referenced models: Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type DEPARTMENT, Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type USER, Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type VENDOR, Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type ADDRESS, Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type BOOLEAN, Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type CONTACT, Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type DATE, Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type EMAIL, Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type FILE UPLOAD, Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type LINK, Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type MERCHANT CATEGORY, Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type MERCHANT, Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type MONETARY AMOUNT, Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type NUMBER, Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type PARAGRAPH, Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type TEXT, Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type TEXT MULTI SELECT, Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type TEXT SINGLE SELECT

Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type ADDRESS

FieldTypePresenceDescription and constraints
$objectRoot
commentJSONOptional
comment (anyOf 1)stringAlternativeDefault: null
comment (anyOf 2)nullAlternative
field_typestringRequired within parentMust equal: ADDRESS
mapped_fieldsarrayOptional
mapped_fields[]ModelEach itemExpand Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type ADDRESS mapped fields item
valueJSONRequired within parent
value (anyOf 1)ModelAlternativeExpand Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type ADDRESS value address1, address2, city, country, postal code, state
value (anyOf 2)nullAlternative

Referenced models: Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type ADDRESS value address1, address2, city, country, postal code, state, Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type ADDRESS mapped fields item

Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type ADDRESS mapped fields item

FieldTypePresenceDescription and constraints
$JSONRootdiscriminator: {"mapping": {"PAYEE__CUSTOM_RECORDS": "#/components/schemas/PayeeCustomRecordMappedFieldSchema", "PURCHASE_ORDER__BILL_TO_ADDRESS": "#/components/schemas/PurchaseOrderBillToAddressMappedFieldSchema", "PURCHASE_ORDER__PAYEE_ADDRESS": "#/components/schemas/PurchaseOrderPayeeAddressMappedFieldSchema", "PURCHASE_ORDER__SHIP_TO_ADDRESS": "#/components/schemas/PurchaseOrderShipToAddressMappedFieldSchema"}, "propertyName": "mapped_field"}
$ (anyOf 1)ModelAlternativeExpand Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type DATE mapped fields item mapped field PAYEE CUSTOM RECORDS
$ (anyOf 2)ModelAlternativeExpand Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type ADDRESS mapped fields item mapped field PURCHASE ORDER BILL TO ADDRESS
$ (anyOf 3)ModelAlternativeExpand Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type ADDRESS mapped fields item mapped field PURCHASE ORDER PAYEE ADDRESS
$ (anyOf 4)ModelAlternativeExpand Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type ADDRESS mapped fields item mapped field PURCHASE ORDER SHIP TO ADDRESS

Referenced models: Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type DATE mapped fields item mapped field PAYEE CUSTOM RECORDS, Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type ADDRESS mapped fields item mapped field PURCHASE ORDER BILL TO ADDRESS, Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type ADDRESS mapped fields item mapped field PURCHASE ORDER PAYEE ADDRESS, Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type ADDRESS mapped fields item mapped field PURCHASE ORDER SHIP TO ADDRESS

Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type ADDRESS mapped fields item mapped field PURCHASE ORDER BILL TO ADDRESS

FieldTypePresenceDescription and constraints
$objectRoot
mapped_fieldstringRequired within parentMust equal: PURCHASE_ORDER__BILL_TO_ADDRESS

Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type ADDRESS mapped fields item mapped field PURCHASE ORDER PAYEE ADDRESS

FieldTypePresenceDescription and constraints
$objectRoot
mapped_fieldstringRequired within parentMust equal: PURCHASE_ORDER__PAYEE_ADDRESS

Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type ADDRESS mapped fields item mapped field PURCHASE ORDER SHIP TO ADDRESS

FieldTypePresenceDescription and constraints
$objectRoot
mapped_fieldstringRequired within parentMust equal: PURCHASE_ORDER__SHIP_TO_ADDRESS
restrict_to_allowed_valuesbooleanOptionalDefault: false

Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type ADDRESS value address1, address2, city, country, postal code, state

FieldTypePresenceDescription and constraints
$objectRoot
address1stringRequired within parentStreet address line 1
address2JSONOptional
address2 (anyOf 1)stringAlternativeStreet address line 2, e.g. apt number
Default: null
address2 (anyOf 2)nullAlternative
citystringRequired within parentCity name
countrystringRequired within parentCountry code
postal_codeJSONOptional
postal_code (anyOf 1)stringAlternativePostal/ZIP code
Default: null
postal_code (anyOf 2)nullAlternative
stateJSONOptional
state (anyOf 1)stringAlternativeState or province name
Default: null
state (anyOf 2)nullAlternative

Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type BOOLEAN

FieldTypePresenceDescription and constraints
$objectRoot
commentJSONOptional
comment (anyOf 1)stringAlternativeDefault: null
comment (anyOf 2)nullAlternative
field_typestringRequired within parentMust equal: BOOLEAN
mapped_fieldsarrayOptional
mapped_fields[]ModelEach itemExpand Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type BOOLEAN mapped fields item
valueJSONRequired within parent
value (anyOf 1)ModelAlternativeExpand Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type BOOLEAN value value
value (anyOf 2)nullAlternative

Referenced models: Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type BOOLEAN value value, Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type BOOLEAN mapped fields item

Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type BOOLEAN mapped fields item

FieldTypePresenceDescription and constraints
$JSONRootdiscriminator: {"mapping": {"PAYEE__CUSTOM_RECORDS": "#/components/schemas/PayeeCustomRecordMappedFieldSchema", "PURCHASE_ORDER__CUSTOM_FIELD": "#/components/schemas/PurchaseOrderCustomFieldMappedFieldSchema", "SPEND_ALLOCATION__IS_SHAREABLE": "#/components/schemas/SpendAllocationIsShareableMappedFieldSchema"}, "propertyName": "mapped_field"}
$ (anyOf 1)ModelAlternativeExpand Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type DATE mapped fields item mapped field PAYEE CUSTOM RECORDS
$ (anyOf 2)ModelAlternativeExpand Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type DATE mapped fields item mapped field PURCHASE ORDER CUSTOM FIELD
$ (anyOf 3)ModelAlternativeExpand Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type BOOLEAN mapped fields item mapped field SPEND ALLOCATION IS SHAREABLE

Referenced models: Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type DATE mapped fields item mapped field PAYEE CUSTOM RECORDS, Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type DATE mapped fields item mapped field PURCHASE ORDER CUSTOM FIELD, Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type BOOLEAN mapped fields item mapped field SPEND ALLOCATION IS SHAREABLE

Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type BOOLEAN mapped fields item mapped field SPEND ALLOCATION IS SHAREABLE

FieldTypePresenceDescription and constraints
$objectRoot
mapped_fieldstringRequired within parentMust equal: SPEND_ALLOCATION__IS_SHAREABLE

Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type BOOLEAN value value

FieldTypePresenceDescription and constraints
$objectRoot
valuebooleanRequired within parent

Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type CONTACT

FieldTypePresenceDescription and constraints
$objectRoot
commentJSONOptional
comment (anyOf 1)stringAlternativeDefault: null
comment (anyOf 2)nullAlternative
field_typestringRequired within parentMust equal: CONTACT
mapped_fieldsarrayOptional
mapped_fields[]ModelEach itemExpand Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type CONTACT mapped fields item
valueJSONRequired within parent
value (anyOf 1)ModelAlternativeExpand Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type CONTACT value email, first name, last name, phone number
value (anyOf 2)nullAlternative

Referenced models: Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type CONTACT value email, first name, last name, phone number, Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type CONTACT mapped fields item

Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type CONTACT mapped fields item

FieldTypePresenceDescription and constraints
$JSONRootdiscriminator: {"mapping": {"PURCHASE_ORDER__BILLING_CONTACT": "#/components/schemas/PurchaseOrderBillingContactMappedFieldSchema", "PURCHASE_ORDER__PAYEE_CONTACT": "#/components/schemas/PurchaseOrderPayeeContactMappedFieldSchema", "PURCHASE_ORDER__SHIPPING_CONTACT": "#/components/schemas/PurchaseOrderShippingContactMappedFieldSchema"}, "propertyName": "mapped_field"}
$ (anyOf 1)ModelAlternativeExpand Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type CONTACT mapped fields item mapped field PURCHASE ORDER BILLING CONTACT
$ (anyOf 2)ModelAlternativeExpand Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type CONTACT mapped fields item mapped field PURCHASE ORDER PAYEE CONTACT
$ (anyOf 3)ModelAlternativeExpand Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type CONTACT mapped fields item mapped field PURCHASE ORDER SHIPPING CONTACT

Referenced models: Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type CONTACT mapped fields item mapped field PURCHASE ORDER BILLING CONTACT, Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type CONTACT mapped fields item mapped field PURCHASE ORDER PAYEE CONTACT, Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type CONTACT mapped fields item mapped field PURCHASE ORDER SHIPPING CONTACT

Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type CONTACT mapped fields item mapped field PURCHASE ORDER BILLING CONTACT

FieldTypePresenceDescription and constraints
$objectRoot
mapped_fieldstringRequired within parentMust equal: PURCHASE_ORDER__BILLING_CONTACT

Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type CONTACT mapped fields item mapped field PURCHASE ORDER PAYEE CONTACT

FieldTypePresenceDescription and constraints
$objectRoot
mapped_fieldstringRequired within parentMust equal: PURCHASE_ORDER__PAYEE_CONTACT

Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type CONTACT mapped fields item mapped field PURCHASE ORDER SHIPPING CONTACT

FieldTypePresenceDescription and constraints
$objectRoot
mapped_fieldstringRequired within parentMust equal: PURCHASE_ORDER__SHIPPING_CONTACT

Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type CONTACT value email, first name, last name, phone number

FieldTypePresenceDescription and constraints
$objectRoot
emailstringRequired within parentContact email
Format: email
first_nameJSONOptional
first_name (anyOf 1)stringAlternativeDefault: null
first_name (anyOf 2)nullAlternative
last_nameJSONOptional
last_name (anyOf 1)stringAlternativeDefault: null
last_name (anyOf 2)nullAlternative
phone_numberJSONOptional
phone_number (anyOf 1)stringAlternativeContact phone number
Default: null
phone_number (anyOf 2)nullAlternative

Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type DATE

FieldTypePresenceDescription and constraints
$objectRoot
commentJSONOptional
comment (anyOf 1)stringAlternativeDefault: null
comment (anyOf 2)nullAlternative
field_typestringRequired within parentMust equal: DATE
mapped_fieldsarrayOptional
mapped_fields[]ModelEach itemExpand Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type DATE mapped fields item
valueJSONRequired within parent
value (anyOf 1)ModelAlternativeExpand Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type DATE value value
value (anyOf 2)nullAlternative

Referenced models: Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type DATE mapped fields item, Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type DATE value value

Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type DATE mapped fields item

FieldTypePresenceDescription and constraints
$JSONRootdiscriminator: {"mapping": {"PAYEE__CUSTOM_RECORDS": "#/components/schemas/PayeeCustomRecordMappedFieldSchema", "PURCHASE_ORDER__CUSTOM_FIELD": "#/components/schemas/PurchaseOrderCustomFieldMappedFieldSchema", "PURCHASE_ORDER__PROMISE_DATE": "#/components/schemas/PurchaseOrderPromiseDateMappedFieldSchema", "SPEND_ALLOCATION__END_DATE": "#/components/schemas/SpendAllocationEndDateMappedFieldSchema", "SPEND_ALLOCATION__START_DATE": "#/components/schemas/SpendAllocationStartDateMappedFieldSchema"}, "propertyName": "mapped_field"}
$ (anyOf 1)ModelAlternativeExpand Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type DATE mapped fields item mapped field PAYEE CUSTOM RECORDS
$ (anyOf 2)ModelAlternativeExpand Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type DATE mapped fields item mapped field PURCHASE ORDER CUSTOM FIELD
$ (anyOf 3)ModelAlternativeExpand Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type DATE mapped fields item mapped field PURCHASE ORDER PROMISE DATE
$ (anyOf 4)ModelAlternativeExpand Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type DATE mapped fields item mapped field SPEND ALLOCATION END DATE
$ (anyOf 5)ModelAlternativeExpand Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type DATE mapped fields item mapped field SPEND ALLOCATION START DATE

Referenced models: Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type DATE mapped fields item mapped field PAYEE CUSTOM RECORDS, Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type DATE mapped fields item mapped field PURCHASE ORDER CUSTOM FIELD, Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type DATE mapped fields item mapped field PURCHASE ORDER PROMISE DATE, Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type DATE mapped fields item mapped field SPEND ALLOCATION END DATE, Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type DATE mapped fields item mapped field SPEND ALLOCATION START DATE

Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type DATE mapped fields item mapped field PAYEE CUSTOM RECORDS

FieldTypePresenceDescription and constraints
$objectRoot
mapped_custom_column_idJSONOptional
mapped_custom_column_id (anyOf 1)stringAlternativeDefault: null
mapped_custom_column_id (anyOf 2)nullAlternative
mapped_fieldstringRequired within parentMust equal: PAYEE__CUSTOM_RECORDS

Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type DATE mapped fields item mapped field PURCHASE ORDER CUSTOM FIELD

FieldTypePresenceDescription and constraints
$objectRoot
mapped_custom_column_idstringRequired within parentIdentifier of the mapped purchase order custom field column.
mapped_fieldstringRequired within parentMaps the form field to a purchase order custom field.
Must equal: PURCHASE_ORDER__CUSTOM_FIELD

Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type DATE mapped fields item mapped field PURCHASE ORDER PROMISE DATE

FieldTypePresenceDescription and constraints
$objectRoot
mapped_fieldstringRequired within parentMust equal: PURCHASE_ORDER__PROMISE_DATE

Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type DATE mapped fields item mapped field SPEND ALLOCATION END DATE

FieldTypePresenceDescription and constraints
$objectRoot
mapped_fieldstringRequired within parentMust equal: SPEND_ALLOCATION__END_DATE

Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type DATE mapped fields item mapped field SPEND ALLOCATION START DATE

FieldTypePresenceDescription and constraints
$objectRoot
mapped_fieldstringRequired within parentMust equal: SPEND_ALLOCATION__START_DATE

Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type DATE value value

FieldTypePresenceDescription and constraints
$objectRoot
valuestringRequired within parent

Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type DEPARTMENT

FieldTypePresenceDescription and constraints
$objectRoot
commentJSONOptional
comment (anyOf 1)stringAlternativeDefault: null
comment (anyOf 2)nullAlternative
field_typestringRequired within parentMust equal: DEPARTMENT
valueJSONRequired within parent
value (anyOf 1)ModelAlternativeExpand Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type DEPARTMENT value department name, department uuid
value (anyOf 2)nullAlternative

Referenced models: Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type DEPARTMENT value department name, department uuid

Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type DEPARTMENT value department name, department uuid

FieldTypePresenceDescription and constraints
$objectRoot
department_namestringRequired within parent
department_uuidstringRequired within parent

Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type EMAIL

FieldTypePresenceDescription and constraints
$objectRoot
commentJSONOptional
comment (anyOf 1)stringAlternativeDefault: null
comment (anyOf 2)nullAlternative
field_typestringRequired within parentMust equal: EMAIL
mapped_fieldsarrayOptional
mapped_fields[]ModelEach itemExpand Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type LINK mapped fields item
valueJSONRequired within parent
value (anyOf 1)ModelAlternativeExpand Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type DATE value value
value (anyOf 2)nullAlternative

Referenced models: Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type LINK mapped fields item, Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type DATE value value

Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type FILE UPLOAD

FieldTypePresenceDescription and constraints
$objectRoot
allowed_file_typesJSONOptional
allowed_file_types (anyOf 1)arrayAlternativeDefault: null
allowed_file_types (anyOf 1)[]stringEach itemKnown values: base64, csv, doc, docx, eml, gif, gz, heic, html, ics, iif, jpeg, json, jsonl, md, mp3, msg, npy, ods, parquet, pdf, pgp, png, ppt, pptx, py, txt, webp, xls, xlsm, xlsx, xml, zip
allowed_file_types (anyOf 2)nullAlternative
commentJSONOptional
comment (anyOf 1)stringAlternativeDefault: null
comment (anyOf 2)nullAlternative
document_categoryJSONOptional
document_category (anyOf 1)ModelAlternativeExpand Fetch a spend program β€” response body β€” custom form collection custom form collection log entry custom form collection log entry forms, label forms item fields item document category string
Default: null
document_category (anyOf 2)nullAlternative
field_typestringRequired within parentMust equal: FILE_UPLOAD
mapped_fieldsarrayOptional
mapped_fields[]ModelEach itemExpand Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type FILE UPLOAD mapped fields item
valueJSONRequired within parent
value (anyOf 1)arrayAlternative
value (anyOf 1)[]ModelEach itemExpand Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type FILE UPLOAD value array item
value (anyOf 2)nullAlternative

Referenced models: Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type FILE UPLOAD mapped fields item, Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type FILE UPLOAD value array item, Fetch a spend program β€” response body β€” custom form collection custom form collection log entry custom form collection log entry forms, label forms item fields item document category string

Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type FILE UPLOAD mapped fields item

FieldTypePresenceDescription and constraints
$JSONRootdiscriminator: {"mapping": {"PURCHASE_ORDER__ATTACHMENTS": "#/components/schemas/PurchaseOrderAttachmentsMappedFieldSchema"}, "propertyName": "mapped_field"}
$ (anyOf 1)ModelAlternativeExpand Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type FILE UPLOAD mapped fields item mapped field PURCHASE ORDER ATTACHMENTS

Referenced models: Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type FILE UPLOAD mapped fields item mapped field PURCHASE ORDER ATTACHMENTS

Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type FILE UPLOAD mapped fields item mapped field PURCHASE ORDER ATTACHMENTS

FieldTypePresenceDescription and constraints
$objectRoot
mapped_fieldstringRequired within parentMust equal: PURCHASE_ORDER__ATTACHMENTS

Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type FILE UPLOAD value array item

FieldTypePresenceDescription and constraints
$objectRoot
displayed_filenamestringRequired within parent
document_categoryModelRequired within parentExpand Fetch a spend program β€” response body β€” custom form collection custom form collection log entry custom form collection log entry forms, label forms item fields item document category string
file_urlstringRequired within parent
file_uuidstringRequired within parent
spend_request_document_uuidJSONRequired within parent
spend_request_document_uuid (anyOf 1)stringAlternative
spend_request_document_uuid (anyOf 2)nullAlternative
typestringOptionalKnown values: FILE_VALUE
Default: FILE_VALUE

Referenced models: Fetch a spend program β€” response body β€” custom form collection custom form collection log entry custom form collection log entry forms, label forms item fields item document category string

Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type LINK

FieldTypePresenceDescription and constraints
$objectRoot
commentJSONOptional
comment (anyOf 1)stringAlternativeDefault: null
comment (anyOf 2)nullAlternative
field_typestringRequired within parentMust equal: LINK
mapped_fieldsarrayOptional
mapped_fields[]ModelEach itemExpand Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type LINK mapped fields item
valueJSONRequired within parent
value (anyOf 1)ModelAlternativeExpand Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type DATE value value
value (anyOf 2)nullAlternative

Referenced models: Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type LINK mapped fields item, Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type DATE value value

Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type LINK mapped fields item

FieldTypePresenceDescription and constraints
$JSONRootdiscriminator: {"mapping": {"PAYEE__CUSTOM_RECORDS": "#/components/schemas/PayeeCustomRecordMappedFieldSchema"}, "propertyName": "mapped_field"}
$ (anyOf 1)ModelAlternativeExpand Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type DATE mapped fields item mapped field PAYEE CUSTOM RECORDS

Referenced models: Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type DATE mapped fields item mapped field PAYEE CUSTOM RECORDS

Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type MERCHANT

FieldTypePresenceDescription and constraints
$objectRoot
commentJSONOptional
comment (anyOf 1)stringAlternativeDefault: null
comment (anyOf 2)nullAlternative
field_typestringRequired within parentMust equal: MERCHANT
mapped_fieldsarrayOptional
mapped_fields[]JSONEach itemdiscriminator: {"mapping": {"SPEND_ALLOCATION__MERCHANT_RESTRICTIONS": "#/components/schemas/SpendAllocationMerchantRestrictionsMappedFieldResponseSchema", "SPEND_ALLOCATION__MERCHANT_RESTRICTIONS_ALLOWLIST": "#/components/schemas/SpendAllocationMerchantRestrictionsAllowListMappedFieldSchema", "SPEND_ALLOCATION__MERCHANT_RESTRICTIONS_BLOCKLIST": "#/components/schemas/SpendAllocationMerchantRestrictionsBlockListMappedFieldSchema"}, "propertyName": "mapped_field"}
mapped_fields[] (anyOf 1)ModelAlternativeExpand Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type MERCHANT mapped fields item mapped field SPEND ALLOCATION MERCHANT RESTRICTIONS ALLOWLIST
mapped_fields[] (anyOf 2)ModelAlternativeExpand Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type MERCHANT mapped fields item mapped field SPEND ALLOCATION MERCHANT RESTRICTIONS BLOCKLIST
mapped_fields[] (anyOf 3)ModelAlternativeExpand Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type MERCHANT mapped fields item mapped field SPEND ALLOCATION MERCHANT RESTRICTIONS
valueJSONRequired within parent
value (anyOf 1)arrayAlternative
value (anyOf 1)[]ModelEach itemExpand Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type MERCHANT value array item
value (anyOf 2)nullAlternative

Referenced models: Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type MERCHANT value array item, Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type MERCHANT mapped fields item mapped field SPEND ALLOCATION MERCHANT RESTRICTIONS ALLOWLIST, Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type MERCHANT mapped fields item mapped field SPEND ALLOCATION MERCHANT RESTRICTIONS BLOCKLIST, Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type MERCHANT mapped fields item mapped field SPEND ALLOCATION MERCHANT RESTRICTIONS

Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type MERCHANT CATEGORY

FieldTypePresenceDescription and constraints
$objectRoot
commentJSONOptional
comment (anyOf 1)stringAlternativeDefault: null
comment (anyOf 2)nullAlternative
field_typestringRequired within parentMust equal: MERCHANT_CATEGORY
mapped_fieldsarrayOptional
mapped_fields[]JSONEach itemdiscriminator: {"mapping": {"SPEND_ALLOCATION__MERCHANT_CATEGORY_RESTRICTIONS": "#/components/schemas/SpendAllocationMerchantCategoryRestrictionsMappedFieldResponseSchema", "SPEND_ALLOCATION__MERCHANT_CATEGORY_RESTRICTIONS_ALLOWLIST": "#/components/schemas/SpendAllocationMerchantCategoryRestrictionsAllowListMappedFieldSchema", "SPEND_ALLOCATION__MERCHANT_CATEGORY_RESTRICTIONS_BLOCKLIST": "#/components/schemas/SpendAllocationMerchantCategoryRestrictionsBlockListMappedFieldSchema"}, "propertyName": "mapped_field"}
mapped_fields[] (anyOf 1)ModelAlternativeExpand Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type MERCHANT CATEGORY mapped fields item mapped field SPEND ALLOCATION MERCHANT CATEGORY RESTRICTIONS ALLOWLIST
mapped_fields[] (anyOf 2)ModelAlternativeExpand Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type MERCHANT CATEGORY mapped fields item mapped field SPEND ALLOCATION MERCHANT CATEGORY RESTRICTIONS BLOCKLIST
mapped_fields[] (anyOf 3)ModelAlternativeExpand Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type MERCHANT CATEGORY mapped fields item mapped field SPEND ALLOCATION MERCHANT CATEGORY RESTRICTIONS
valueJSONRequired within parent
value (anyOf 1)arrayAlternative
value (anyOf 1)[]ModelEach itemExpand Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type MERCHANT CATEGORY value array item
value (anyOf 2)nullAlternative

Referenced models: Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type MERCHANT CATEGORY value array item, Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type MERCHANT CATEGORY mapped fields item mapped field SPEND ALLOCATION MERCHANT CATEGORY RESTRICTIONS ALLOWLIST, Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type MERCHANT CATEGORY mapped fields item mapped field SPEND ALLOCATION MERCHANT CATEGORY RESTRICTIONS BLOCKLIST, Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type MERCHANT CATEGORY mapped fields item mapped field SPEND ALLOCATION MERCHANT CATEGORY RESTRICTIONS

Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type MERCHANT CATEGORY mapped fields item mapped field SPEND ALLOCATION MERCHANT CATEGORY RESTRICTIONS

FieldTypePresenceDescription and constraints
$objectRoot
mapped_fieldstringOptionalMust equal: SPEND_ALLOCATION__MERCHANT_CATEGORY_RESTRICTIONS
metadataJSONOptional
metadata (anyOf 1)ModelAlternativeExpand Fetch a custom form collection response by ID β€” response body β€” custom_form_collection_response / custom_form_collection_log_entry / allow_comments, forms, label / forms / item / fields / item / field / field_type MERCHANT / mapped_fields / item / mapped_field SPEND_ALLOCATION__MERCHANT_RESTRICTIONS / metadata / restriction_control_type: ALLOWLIST, BLOCKLIST
Default: null
metadata (anyOf 2)nullAlternative

Referenced models: Fetch a custom form collection response by ID β€” response body β€” custom_form_collection_response / custom_form_collection_log_entry / allow_comments, forms, label / forms / item / fields / item / field / field_type MERCHANT / mapped_fields / item / mapped_field SPEND_ALLOCATION__MERCHANT_RESTRICTIONS / metadata / restriction_control_type: ALLOWLIST, BLOCKLIST

Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type MERCHANT CATEGORY mapped fields item mapped field SPEND ALLOCATION MERCHANT CATEGORY RESTRICTIONS ALLOWLIST

FieldTypePresenceDescription and constraints
$objectRoot
mapped_fieldstringRequired within parentMust equal: SPEND_ALLOCATION__MERCHANT_CATEGORY_RESTRICTIONS_ALLOWLIST

Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type MERCHANT CATEGORY mapped fields item mapped field SPEND ALLOCATION MERCHANT CATEGORY RESTRICTIONS BLOCKLIST

FieldTypePresenceDescription and constraints
$objectRoot
mapped_fieldstringRequired within parentMust equal: SPEND_ALLOCATION__MERCHANT_CATEGORY_RESTRICTIONS_BLOCKLIST

Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type MERCHANT CATEGORY value array item

FieldTypePresenceDescription and constraints
$objectRoot
category_idJSONRequired within parent
category_id (anyOf 1)integerAlternative
category_id (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
category_namestringRequired within parent

Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type MERCHANT mapped fields item mapped field SPEND ALLOCATION MERCHANT RESTRICTIONS

FieldTypePresenceDescription and constraints
$objectRoot
mapped_fieldstringOptionalMust equal: SPEND_ALLOCATION__MERCHANT_RESTRICTIONS
metadataJSONOptional
metadata (anyOf 1)ModelAlternativeExpand Fetch a custom form collection response by ID β€” response body β€” custom_form_collection_response / custom_form_collection_log_entry / allow_comments, forms, label / forms / item / fields / item / field / field_type MERCHANT / mapped_fields / item / mapped_field SPEND_ALLOCATION__MERCHANT_RESTRICTIONS / metadata / restriction_control_type: ALLOWLIST, BLOCKLIST
Default: null
metadata (anyOf 2)nullAlternative

Referenced models: Fetch a custom form collection response by ID β€” response body β€” custom_form_collection_response / custom_form_collection_log_entry / allow_comments, forms, label / forms / item / fields / item / field / field_type MERCHANT / mapped_fields / item / mapped_field SPEND_ALLOCATION__MERCHANT_RESTRICTIONS / metadata / restriction_control_type: ALLOWLIST, BLOCKLIST

Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type MERCHANT mapped fields item mapped field SPEND ALLOCATION MERCHANT RESTRICTIONS ALLOWLIST

FieldTypePresenceDescription and constraints
$objectRoot
mapped_fieldstringRequired within parentMust equal: SPEND_ALLOCATION__MERCHANT_RESTRICTIONS_ALLOWLIST

Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type MERCHANT mapped fields item mapped field SPEND ALLOCATION MERCHANT RESTRICTIONS BLOCKLIST

FieldTypePresenceDescription and constraints
$objectRoot
mapped_fieldstringRequired within parentMust equal: SPEND_ALLOCATION__MERCHANT_RESTRICTIONS_BLOCKLIST

Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type MERCHANT value array item

FieldTypePresenceDescription and constraints
$objectRoot
merchant_idJSONRequired within parent
merchant_id (anyOf 1)integerAlternative
merchant_id (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
merchant_namestringRequired within parent

Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type MONETARY AMOUNT

FieldTypePresenceDescription and constraints
$objectRoot
commentJSONOptional
comment (anyOf 1)stringAlternativeDefault: null
comment (anyOf 2)nullAlternative
field_typestringRequired within parentMust equal: MONETARY_AMOUNT
mapped_fieldsarrayOptional
mapped_fields[]ModelEach itemExpand Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type LINK mapped fields item
valueJSONRequired within parent
value (anyOf 1)ModelAlternativeExpand Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type MONETARY AMOUNT value amount, currency
value (anyOf 2)nullAlternative

Referenced models: Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type LINK mapped fields item, Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type MONETARY AMOUNT value amount, currency

Fetch a custom form collection response by ID β€” response body β€” custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field field type MONETARY AMOUNT value amount, currency

FieldTypePresenceDescription and constraints
$objectRoot
amountJSONRequired within parent
amount (anyOf 1)numberAlternativeMonetary amount in currency units (e.g. dollars, euros, etc.)
amount (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
currencystringRequired within parentCurrency code

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.