Skip to content

Ramp: Custom form schemas (part 2)

32 Ramp schemas with complete fields and constraints.

← Custom form operations · All schemas

Fetch a custom 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

FieldTypePresenceDescription and constraints
$objectRoot
commentJSONOptional
comment (anyOf 1)stringAlternativeDefault: null
comment (anyOf 2)nullAlternative
field_typestringRequired within parentMust equal: NUMBER
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 NUMBER 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 NUMBER 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 NUMBER 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 NUMBER 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 NUMBER mapped fields item

FieldTypePresenceDescription and constraints
$JSONRootdiscriminator: {"mapping": {"PAYEE__CUSTOM_RECORDS": "#/components/schemas/PayeeCustomRecordMappedFieldSchema", "PAYEE__NET_PAYMENT_TERMS": "#/components/schemas/PayeeNetPaymentTermsMappedFieldSchema", "PURCHASE_ORDER__NET_PAYMENT_TERMS": "#/components/schemas/PurchaseOrderNetPaymentTermsMappedFieldSchema", "SPEND_ALLOCATION__EXPENSE_AMOUNT_LIMIT": "#/components/schemas/SpendAllocationExpenseAmountLimitMappedFieldSchema"}, "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 NUMBER mapped fields item mapped field PAYEE NET PAYMENT TERMS
$ (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 NUMBER mapped fields item mapped field PURCHASE ORDER NET PAYMENT TERMS
$ (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 NUMBER mapped fields item mapped field SPEND ALLOCATION EXPENSE AMOUNT LIMIT

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 NUMBER mapped fields item mapped field PAYEE NET PAYMENT TERMS, Fetch a custom 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 mapped fields item mapped field PURCHASE ORDER NET PAYMENT TERMS, Fetch a custom 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 mapped fields item mapped field SPEND ALLOCATION EXPENSE AMOUNT LIMIT

Fetch a custom 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 mapped fields item mapped field PAYEE NET PAYMENT TERMS

FieldTypePresenceDescription and constraints
$objectRoot
mapped_fieldstringRequired within parentMust equal: PAYEE__NET_PAYMENT_TERMS

Fetch a custom 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 mapped fields item mapped field PURCHASE ORDER NET PAYMENT TERMS

FieldTypePresenceDescription and constraints
$objectRoot
mapped_fieldstringRequired within parentMust equal: PURCHASE_ORDER__NET_PAYMENT_TERMS

Fetch a custom 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 mapped fields item mapped field SPEND ALLOCATION EXPENSE AMOUNT LIMIT

FieldTypePresenceDescription and constraints
$objectRoot
mapped_fieldstringRequired within parentMust equal: SPEND_ALLOCATION__EXPENSE_AMOUNT_LIMIT

Fetch a custom 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 value value

FieldTypePresenceDescription and constraints
$objectRoot
valueJSONRequired within parent
value (anyOf 1)numberAlternative
value (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 field field type PARAGRAPH

FieldTypePresenceDescription and constraints
$objectRoot
commentJSONOptional
comment (anyOf 1)stringAlternativeDefault: null
comment (anyOf 2)nullAlternative
field_typestringRequired within parentMust equal: PARAGRAPH
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 PARAGRAPH 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 PARAGRAPH 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 PARAGRAPH mapped fields item

FieldTypePresenceDescription and constraints
$JSONRootdiscriminator: {"mapping": {"PAYEE__CUSTOM_RECORDS": "#/components/schemas/PayeeCustomRecordMappedFieldSchema", "PAYEE__DESCRIPTION": "#/components/schemas/PayeeDescriptionMappedFieldSchema", "PURCHASE_ORDER__MEMO": "#/components/schemas/PurchaseOrderMemoMappedFieldSchema", "REQUEST_REASON": "#/components/schemas/RequestReasonMappedFieldSchema"}, "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 PARAGRAPH mapped fields item mapped field PAYEE DESCRIPTION
$ (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 PARAGRAPH mapped fields item mapped field PURCHASE ORDER MEMO
$ (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 PARAGRAPH mapped fields item mapped field REQUEST REASON

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 PARAGRAPH mapped fields item mapped field PAYEE DESCRIPTION, Fetch a custom 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 mapped fields item mapped field PURCHASE ORDER MEMO, Fetch a custom 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 mapped fields item mapped field REQUEST REASON

Fetch a custom 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 mapped fields item mapped field PAYEE DESCRIPTION

FieldTypePresenceDescription and constraints
$objectRoot
mapped_fieldstringRequired within parentMust equal: PAYEE__DESCRIPTION

Fetch a custom 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 mapped fields item mapped field PURCHASE ORDER MEMO

FieldTypePresenceDescription and constraints
$objectRoot
mapped_fieldstringRequired within parentMust equal: PURCHASE_ORDER__MEMO

Fetch a custom 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 mapped fields item mapped field REQUEST REASON

FieldTypePresenceDescription and constraints
$objectRoot
mapped_fieldstringRequired within parentMust equal: REQUEST_REASON

Fetch a custom 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

FieldTypePresenceDescription and constraints
$objectRoot
commentJSONOptional
comment (anyOf 1)stringAlternativeDefault: null
comment (anyOf 2)nullAlternative
field_typestringRequired within parentMust equal: TEXT
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 TEXT 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 TEXT 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 TEXT MULTI SELECT

FieldTypePresenceDescription and constraints
$objectRoot
choicesarrayOptional
choices[]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 TEXT MULTI SELECT choices item
commentJSONOptional
comment (anyOf 1)stringAlternativeDefault: null
comment (anyOf 2)nullAlternative
field_typestringRequired within parentMust equal: TEXT_MULTI_SELECT
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)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 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 TEXT MULTI SELECT choices 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 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 TEXT MULTI SELECT choices item

FieldTypePresenceDescription and constraints
$objectRoot
is_used_in_approval_workflow_conditionJSONOptional
is_used_in_approval_workflow_condition (anyOf 1)booleanAlternativeWhether this choice is referenced by an approval workflow condition.
Default: null
is_used_in_approval_workflow_condition (anyOf 2)nullAlternative
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 field field type DATE value value
value_idstringRequired 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 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 TEXT SINGLE SELECT

FieldTypePresenceDescription and constraints
$objectRoot
choicesarrayOptional
choices[]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 TEXT MULTI SELECT choices item
commentJSONOptional
comment (anyOf 1)stringAlternativeDefault: null
comment (anyOf 2)nullAlternative
field_typestringRequired within parentMust equal: TEXT_SINGLE_SELECT
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 TEXT SINGLE SELECT 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 TEXT MULTI SELECT choices 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 TEXT SINGLE SELECT 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 TEXT SINGLE SELECT mapped fields item

FieldTypePresenceDescription and constraints
$JSONRootdiscriminator: {"mapping": {"PAYEE__CUSTOM_RECORDS": "#/components/schemas/PayeeCustomRecordMappedFieldSchema", "PURCHASE_ORDER__CUSTOM_FIELD": "#/components/schemas/PurchaseOrderCustomFieldMappedFieldSchema"}, "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

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 TEXT mapped fields item

FieldTypePresenceDescription and constraints
$JSONRootdiscriminator: {"mapping": {"PAYEE__CUSTOM_RECORDS": "#/components/schemas/PayeeCustomRecordMappedFieldSchema", "PURCHASE_ORDER__CUSTOM_FIELD": "#/components/schemas/PurchaseOrderCustomFieldMappedFieldSchema", "REQUEST_NAME": "#/components/schemas/RequestNameMappedFieldSchema"}, "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 TEXT mapped fields item mapped field REQUEST NAME

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 TEXT mapped fields item mapped field REQUEST NAME

Fetch a custom 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 mapped fields item mapped field REQUEST NAME

FieldTypePresenceDescription and constraints
$objectRoot
mapped_fieldstringRequired within parentMust equal: REQUEST_NAME

Fetch a custom 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

FieldTypePresenceDescription and constraints
$objectRoot
commentJSONOptional
comment (anyOf 1)stringAlternativeOptional comment supplied with the field response.
Default: null
comment (anyOf 2)nullAlternative
field_typestringRequired within parentField type discriminator for a user selection field.
Must equal: USER
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 allowed users array item
Selected user, or null when no user was selected.
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 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 field field type VENDOR

FieldTypePresenceDescription and constraints
$objectRoot
commentJSONOptional
comment (anyOf 1)stringAlternativeDefault: null
comment (anyOf 2)nullAlternative
field_typestringRequired within parentMust equal: VENDOR
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 VENDOR value payee uuid, vendor contact, vendor logo, vendor name
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 VENDOR value payee uuid, vendor contact, vendor logo, vendor name

Fetch a custom 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 value payee uuid, vendor contact, vendor logo, vendor name

FieldTypePresenceDescription and constraints
$objectRoot
payee_uuidJSONOptional
payee_uuid (anyOf 1)stringAlternativeDefault: null
payee_uuid (anyOf 2)nullAlternative
vendor_contactJSONOptional
vendor_contact (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 VENDOR value payee uuid, vendor contact, vendor logo, vendor name vendor contact email, first name, id, is default, last name, phone
Default: null
vendor_contact (anyOf 2)nullAlternative
vendor_logoJSONOptional
vendor_logo (anyOf 1)stringAlternativeDefault: null
vendor_logo (anyOf 2)nullAlternative
vendor_namestringRequired 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 field field type VENDOR value payee uuid, vendor contact, vendor logo, vendor name vendor contact email, first name, id, is default, last name, phone

Fetch a custom 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 value payee uuid, vendor contact, vendor logo, vendor name vendor contact email, first name, id, is default, last name, phone

FieldTypePresenceDescription and constraints
$objectRoot
emailJSONRequired within parent
email (anyOf 1)stringAlternative
email (anyOf 2)nullAlternative
first_nameJSONOptional
first_name (anyOf 1)stringAlternativeDefault: null
first_name (anyOf 2)nullAlternative
idstringRequired within parent
is_defaultbooleanRequired within parent
last_nameJSONOptional
last_name (anyOf 1)stringAlternativeDefault: null
last_name (anyOf 2)nullAlternative
phoneJSONOptional
phone (anyOf 1)stringAlternativeDefault: null
phone (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 mapping references item

FieldTypePresenceDescription and constraints
$objectRoot
approval_trigger_metadata_uuidstringRequired within parentUUID of the approval-step metadata that owns the field mapping.
node_idJSONOptional
node_id (anyOf 1)stringAlternativeConsuming node in a current or draft workflow, or null when none exists.
Default: null
node_id (anyOf 2)nullAlternative
remote_systemModelRequired 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 mapping references item remote system
Integration provider that consumes the mapped question.
workflow_idJSONOptional
workflow_id (anyOf 1)stringAlternativeBlank canvas workflow that owns node_id, or null when node_id is null or the node is in a subflow.
Default: null
workflow_id (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 mapping references item remote system

Fetch a custom 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 remote system

FieldTypePresenceDescription and constraints
$stringRootThe type of remote/external system being integrated with.

This enum identifies which third-party system the field mapping is for.
Values are automatically registered by clients that implement FieldMappingFeature
and register with FieldMappingClientRegistry.

To add a new system:
1. Have your client implement FieldMappingFeature interface
2. Add the client to initialize_registries() in field_mapping/registry.py
3. Add the enum value here

See suma/proxy/procurement_integrations/field_mapping_interface.py for details.
Known values: ARAVO, DOCUSIGN, DRATA, IRONCLAD, LOGICGATE, MERGE, ONETRUST, VANTA

Fetch a custom 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

FieldTypePresenceDescription and constraints
$objectRoot
messagestringRequired 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_REFERENCE, type: ARRAY, BOOL, INT, JSONB, NUMERIC, STR

FieldTypePresenceDescription and constraints
$objectRoot
child_typeJSONOptional
child_type (anyOf 1)stringAlternativeRead only: true
child_type (anyOf 2)nullAlternative
displaystringRequired within parentRead only: true
maskJSONOptional
mask (anyOf 1)stringAlternativeKnown values: CURRENCY, DAY, PERCENTAGE
Read only: true
mask (anyOf 2)nullAlternative
operand_typestringRequired within parentMust equal: STATE_REFERENCE
typestringOptionalKnown values: ARRAY, BOOL, INT, JSONB, NUMERIC, STR
Read only: true
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_GROUP, operator: ALL, ANY, NOT

FieldTypePresenceDescription and constraints
$objectRoot
condition_item_typestringRequired within parentMust equal: CONDITION_GROUP
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 / 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

FieldTypePresenceDescription and constraints
$objectRoot
child_typestringRequired within parentKnown values: ARRAY, BOOL, INT, JSONB, NUMERIC, STR
typestringRequired within parentMust equal: ARRAY
valueJSONOptional
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 conditions condition, then then item vertex type ACTION action kwargs item action kwarg type TYPED KEY VALUE PAIR 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 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 / available_operands / item / available_operand_type STATE, state_type: CONSTANT, DYNAMIC, STATIC, type: ARRAY, BOOL, INT, JSONB, NUMERIC, STR

FieldTypePresenceDescription and constraints
$objectRoot
available_operand_typestringRequired within parentMust equal: STATE
child_typeJSONOptional
child_type (anyOf 1)stringAlternative
child_type (anyOf 2)nullAlternative
displaystringRequired within parentRead only: true
keystringRequired within parent
maskJSONOptional
mask (anyOf 1)stringAlternativeKnown values: CURRENCY, DAY, PERCENTAGE
Read only: true
mask (anyOf 2)nullAlternative
state_typestringRequired within parentKnown values: CONSTANT, DYNAMIC, STATIC
typestringRequired within parentKnown values: 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

FieldTypePresenceDescription and constraints
$objectRoot
available_operand_typestringRequired within parentMust equal: STATE_OBJECT
displaystringRequired within parentRead only: true
keystringRequired within parent
maskJSONOptional
mask (anyOf 1)stringAlternativeKnown values: CURRENCY, DAY, PERCENTAGE
Read only: true
mask (anyOf 2)nullAlternative
object_typestringRequired within parentRead only: true
state_typestringRequired within parentKnown values: 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

FieldTypePresenceDescription and constraints
$objectRoot
available_operand_typestringRequired within parentMust equal: STATE_OBJECT_LIST
displaystringRequired within parentRead only: true
keystringRequired within parent
maskJSONOptional
mask (anyOf 1)stringAlternativeKnown values: CURRENCY, DAY, PERCENTAGE
Read only: true
mask (anyOf 2)nullAlternative
object_list_typestringRequired within parentRead only: true
state_typestringRequired within parentKnown values: 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 / field / field_type MERCHANT / mapped_fields / item / mapped_field SPEND_ALLOCATION__MERCHANT_RESTRICTIONS / metadata / restriction_control_type: ALLOWLIST, BLOCKLIST

FieldTypePresenceDescription and constraints
$objectRoot
restriction_control_typestringRequired within parentKnown values: ALLOWLIST, BLOCKLIST

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.