β Custom form operations Β· All schemas
Fetch a custom form collection response by ID β response body
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
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
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
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
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | |
allowed_dynamic_user_group_uuids | JSON | Optional | |
allowed_dynamic_user_group_uuids (anyOf 1) | array | Alternative | Dynamic user groups whose members may be selected for this field. Default: null |
allowed_dynamic_user_group_uuids (anyOf 1)[] | string | Each item | |
allowed_dynamic_user_group_uuids (anyOf 2) | null | Alternative | |
allowed_users | JSON | Optional | |
allowed_users (anyOf 1) | array | Alternative | Eligible users resolved for this form. Null applies no additional restriction; an empty list means no eligible users. Default: null |
allowed_users (anyOf 1)[] | Model | Each item | Expand Fetch a custom 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) | null | Alternative | |
approval_workflow_references | JSON | Optional | |
approval_workflow_references (anyOf 1) | array | Alternative | Approval workflow dependencies; absent or null when unavailable, otherwise complete. Default: null |
approval_workflow_references (anyOf 1)[] | Model | Each item | Expand Fetch a custom 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) | null | Alternative | |
attachments | array | Optional | |
attachments[] | Model | Each item | Expand Fetch a custom 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 |
conditions | JSON | Required within parent | |
conditions (anyOf 1) | Model | Alternative | Expand Fetch a custom 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) | null | Alternative | |
description | JSON | Required within parent | |
description (anyOf 1) | string | Alternative | |
description (anyOf 2) | null | Alternative | |
exclude_from_ai_prefill | boolean | Optional | When True, AI intake/document prefill never generates an answer for this field. Default: false |
field | Model | Required within parent | Expand Fetch a custom form 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_id | string | Required within parent | |
field_mapping_references | array | Optional | Integration field mappings that reference this question. |
field_mapping_references[] | Model | Each item | Expand Fetch a custom form 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_id | JSON | Optional | |
global_library_field_id (anyOf 1) | string | Alternative | Default: null |
global_library_field_id (anyOf 2) | null | Alternative | |
is_mapped_to_ironclad_field | boolean | Optional | Default: false |
is_used_in_approval_workflow_approval_step | boolean | Optional | Whether an approval step selects its approver from this field. Default: false |
is_used_in_approval_workflow_condition | boolean | Optional | Broad compatibility flag for fields used in approval conditions or approval steps. Default: false |
is_used_in_custom_form_workflow_condition | boolean | Optional | Default: false |
label | string | Required within parent | |
required | boolean | Required within parent | |
required_if_conditions | JSON | Optional | |
required_if_conditions (anyOf 1) | Model | Alternative | Expand Fetch a custom 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) | null | Alternative | |
short_title | JSON | Optional | |
short_title (anyOf 1) | string | Alternative | Optional concise title copied from a Global Question Library field. Default: null |
short_title (anyOf 2) | null | Alternative | |
validation_errors | array | Optional | |
validation_errors[] | Model | Each item | Expand Fetch a custom 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_string | JSON | Required within parent | |
value_display_string (anyOf 1) | string | Alternative | Read only: true |
value_display_string (anyOf 2) | null | Alternative | |
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
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | |
email | string | Required within parent | Email address of the selected user. |
first_name | string | Required within parent | First name of the selected user. |
last_name | string | Required within parent | Last name of the selected user. |
user_uuid | string | Required within parent | UUID 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
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | |
branch_id | JSON | Optional | |
branch_id (anyOf 1) | string | Alternative | Condition branch identifier, when available. Default: null |
branch_id (anyOf 2) | null | Alternative | |
branch_index | JSON | Optional | |
branch_index (anyOf 1) | JSON | Alternative | |
branch_index (anyOf 1) (anyOf 1) | integer | Alternative | Condition branch position for historical fallback. Default: null |
branch_index (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
branch_index (anyOf 2) | null | Alternative | |
kind | string | Required within parent | Whether the question is used by a condition or approval step. Known values: APPROVAL_STEP, CONDITION |
label | JSON | Optional | |
label (anyOf 1) | string | Alternative | Branch or approval step label; null when unnamed. Default: null |
label (anyOf 2) | null | Alternative | |
node_id | string | Required within parent | Referencing workflow graph node identifier. |
referenced_choice_labels | array | Optional | Choice labels referenced by the condition. |
referenced_choice_labels[] | string | Each item | |
template_id | string | Required within parent | Exact workflow template version inspected. Format: uuid |
workflow_id | string | Required within parent | Workflow 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
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
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | Base fields for any ramp document version. |
cloudfront_download_url | string | Required within parent | |
cloudfront_url | string | Required within parent | |
created_at | string | Required within parent | Format: date-time |
id | string | Required within parent | |
original_filename | string | Required within parent | |
version_number | JSON | Required within parent | |
version_number (anyOf 1) | integer | Alternative | |
version_number (anyOf 2) | string | Alternative | Pattern: ^-?[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
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
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
| Field | Type | Presence | Description and constraints |
|---|
$ | JSON | Root | discriminator: {"mapping": {"CONDITION": "#/components/schemas/AtomicCondition", "CONDITION_GROUP": "#/components/schemas/NestedConditionGroup"}, "propertyName": "condition_item_type"} |
$ (anyOf 1) | Model | Alternative | Expand Fetch a custom 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) | Model | Alternative | Expand Fetch a custom 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
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
| Field | Type | Presence | Description and constraints |
|---|
$ | JSON | Root | discriminator: {"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) | Model | Alternative | Expand Fetch a custom 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) | Model | Alternative | Expand Fetch a custom 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) | Model | Alternative | Expand Fetch a custom 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) | Model | Alternative | Expand Fetch a custom 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) | Model | Alternative | Expand Fetch a custom 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) | Model | Alternative | Expand Fetch a custom 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
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
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
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | |
deleted | boolean | Optional | Read only: true |
display_name | string | Required within parent | Read only: true |
id | JSON | Required within parent | |
id (anyOf 1) | string | Alternative | |
id (anyOf 2) | null | Alternative | |
Fetch a custom 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
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | |
display | string | Required within parent | Read only: true |
mask | JSON | Optional | |
mask (anyOf 1) | string | Alternative | Known values: CURRENCY, DAY, PERCENTAGE Read only: true |
mask (anyOf 2) | null | Alternative | |
object_list_type | string | Required within parent | Read only: true |
operand_type | string | Required within parent | Must equal: STATE_OBJECT_LIST_REFERENCE |
variable_name | string | Required 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
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | |
display | string | Required within parent | Read only: true |
mask | JSON | Optional | |
mask (anyOf 1) | string | Alternative | Known values: CURRENCY, DAY, PERCENTAGE Read only: true |
mask (anyOf 2) | null | Alternative | |
object_type | string | Required within parent | Read only: true |
operand_type | string | Required within parent | Must equal: STATE_OBJECT_REFERENCE |
variable_name | string | Required 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
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
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | |
operator | string | Required within parent | |
operator_display | string | Required within parent | Read 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
| Field | Type | Presence | Description and constraints |
|---|
$ | JSON | Root | discriminator: {"mapping": {"ACTION": "#/components/schemas/Action", "BLOCK_GROUP": "#/components/schemas/BlockGroup", "CONDITION": "#/components/schemas/ConditionVertex", "SDK_CONDITION": "#/components/schemas/SDKCondition"}, "propertyName": "vertex_type"} |
$ (anyOf 1) | Model | Alternative | Expand Fetch a custom 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) | Model | Alternative | Expand Fetch a custom 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) | Model | Alternative | Expand Fetch a custom 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) | Model | Alternative | Expand Fetch a custom 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
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
| Field | Type | Presence | Description and constraints |
|---|
$ | JSON | Root | discriminator: {"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) | Model | Alternative | Expand Fetch a custom 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) | Model | Alternative | Expand Fetch a custom 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) | Model | Alternative | Expand Fetch a custom 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) | Model | Alternative | Expand Fetch a custom 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
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | |
action_kwarg_type | string | Required within parent | Must equal: KEY_STATE_REFERENCE_TYPE |
key | string | Required within parent | |
variable_name | string | Required 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
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
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
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
| Field | Type | Presence | Description and constraints |
|---|
$ | JSON | Root | discriminator: {"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) | Model | Alternative | Expand Fetch a custom 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) | Model | Alternative | Expand Fetch a custom 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) | Model | Alternative | Expand Fetch a custom 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) | Model | Alternative | Expand Fetch a custom 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) | Model | Alternative | Expand Fetch a custom 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) | Model | Alternative | Expand Fetch a custom 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
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | |
child_type | JSON | Optional | |
child_type (anyOf 1) | string | Alternative | |
child_type (anyOf 2) | null | Alternative | |
type | string | Required within parent | Must equal: BOOL |
value | JSON | Optional | |
value (anyOf 1) | boolean | Alternative | |
value (anyOf 2) | null | Alternative | |
Fetch a custom 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
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | |
child_type | JSON | Optional | |
child_type (anyOf 1) | string | Alternative | |
child_type (anyOf 2) | null | Alternative | |
type | string | Required within parent | Must equal: INT |
value | JSON | Optional | |
value (anyOf 1) | JSON | Alternative | |
value (anyOf 1) (anyOf 1) | integer | Alternative | |
value (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
value (anyOf 2) | null | Alternative | |
Fetch a custom 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
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | |
child_type | JSON | Optional | |
child_type (anyOf 1) | string | Alternative | |
child_type (anyOf 2) | null | Alternative | |
type | string | Required within parent | Must equal: JSONB |
value | JSON | Optional | |
value (anyOf 1) | JSON | Alternative | |
value (anyOf 2) | null | Alternative | |
Fetch a custom 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
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | |
child_type | JSON | Optional | |
child_type (anyOf 1) | string | Alternative | |
child_type (anyOf 2) | null | Alternative | |
type | string | Required within parent | Must equal: NUMERIC |
value | JSON | Optional | |
value (anyOf 1) | JSON | Alternative | |
value (anyOf 1) (anyOf 1) | number | Alternative | |
value (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
value (anyOf 2) | null | Alternative | |
Fetch a custom 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
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | |
child_type | JSON | Optional | |
child_type (anyOf 1) | string | Alternative | |
child_type (anyOf 2) | null | Alternative | |
type | string | Required within parent | Must equal: STR |
value | JSON | Optional | |
value (anyOf 1) | string | Alternative | |
value (anyOf 2) | null | Alternative | |
Fetch a custom 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
| Field | Type | Presence | Description and constraints |
|---|
$ | JSON | Root | discriminator: {"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) | Model | Alternative | Expand Fetch a custom 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) | Model | Alternative | Expand Fetch a custom 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) | Model | Alternative | Expand Fetch a custom 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) | Model | Alternative | Expand Fetch a custom 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
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | |
available_operand_type | string | Required within parent | Must equal: OBJECT |
object_type | string | Required 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
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
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
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | |
available_operands | array | Optional | Read only: true |
available_operands[] | Model | Each item | Expand Fetch a custom 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 |
conditions | array | Required within parent | |
conditions[] | Model | Each item | Expand Fetch a custom 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_blocks | array | Required within parent | |
else_blocks[] | Model | Each item | Expand Fetch a custom 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_group | JSON | Required within parent | |
else_condition_group (anyOf 1) | Model | Alternative | Expand Fetch a custom 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) | null | Alternative | |
has_been_visited | boolean | Optional | Read only: true |
identifier | JSON | Optional | |
identifier (anyOf 1) | string | Alternative | |
identifier (anyOf 2) | null | Alternative | |
metadata | JSON | Optional | |
uuid | string | Required within parent | Format: uuid |
vertex_type | string | Required within parent | Must 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
| Field | Type | Presence | Description and constraints |
|---|
$ | JSON | Root | discriminator: {"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) | Model | Alternative | Expand Fetch a custom form 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) | Model | Alternative | Expand Fetch a custom form 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) | Model | Alternative | Expand Fetch a custom form 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) | Model | Alternative | Expand Fetch a custom form 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) | Model | Alternative | Expand Fetch a custom form 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) | Model | Alternative | Expand Fetch a custom form 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) | Model | Alternative | Expand Fetch a custom form 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) | Model | Alternative | Expand Fetch a custom form 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) | Model | Alternative | Expand Fetch a custom form 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) | Model | Alternative | Expand Fetch a custom form 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) | Model | Alternative | Expand Fetch a custom form 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) | Model | Alternative | Expand Fetch a custom form 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) | Model | Alternative | Expand Fetch a custom form 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) | Model | Alternative | Expand Fetch a custom form 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) | Model | Alternative | Expand Fetch a custom form 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) | Model | Alternative | Expand Fetch a custom form 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) | Model | Alternative | Expand Fetch a custom form 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) | Model | Alternative | Expand Fetch a custom form 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
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
| Field | Type | Presence | Description and constraints |
|---|
$ | JSON | Root | discriminator: {"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) | Model | Alternative | Expand Fetch a custom form 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) | Model | Alternative | Expand Fetch a custom form 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) | Model | Alternative | Expand Fetch a custom form 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) | Model | Alternative | Expand Fetch a custom form 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
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | |
mapped_field | string | Required within parent | Must 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
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | |
mapped_field | string | Required within parent | Must 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
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | |
mapped_field | string | Required within parent | Must equal: PURCHASE_ORDER__SHIP_TO_ADDRESS |
restrict_to_allowed_values | boolean | Optional | Default: 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
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | |
address1 | string | Required within parent | Street address line 1 |
address2 | JSON | Optional | |
address2 (anyOf 1) | string | Alternative | Street address line 2, e.g. apt number Default: null |
address2 (anyOf 2) | null | Alternative | |
city | string | Required within parent | City name |
country | string | Required within parent | Country code |
postal_code | JSON | Optional | |
postal_code (anyOf 1) | string | Alternative | Postal/ZIP code Default: null |
postal_code (anyOf 2) | null | Alternative | |
state | JSON | Optional | |
state (anyOf 1) | string | Alternative | State or province name Default: null |
state (anyOf 2) | null | Alternative | |
Fetch a custom form 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
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
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
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | |
mapped_field | string | Required within parent | Must 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
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | |
value | boolean | Required 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
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
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
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | |
mapped_field | string | Required within parent | Must 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
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | |
mapped_field | string | Required within parent | Must 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
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | |
mapped_field | string | Required within parent | Must 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
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | |
email | string | Required within parent | Contact email Format: email |
first_name | JSON | Optional | |
first_name (anyOf 1) | string | Alternative | Default: null |
first_name (anyOf 2) | null | Alternative | |
last_name | JSON | Optional | |
last_name (anyOf 1) | string | Alternative | Default: null |
last_name (anyOf 2) | null | Alternative | |
phone_number | JSON | Optional | |
phone_number (anyOf 1) | string | Alternative | Contact phone number Default: null |
phone_number (anyOf 2) | null | Alternative | |
Fetch a custom form 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
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
| Field | Type | Presence | Description and constraints |
|---|
$ | JSON | Root | discriminator: {"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) | Model | Alternative | Expand Fetch a custom form 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) | Model | Alternative | Expand Fetch a custom form 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) | Model | Alternative | Expand Fetch a custom form 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) | Model | Alternative | Expand Fetch a custom form 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) | Model | Alternative | Expand Fetch a custom form 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
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | |
mapped_custom_column_id | JSON | Optional | |
mapped_custom_column_id (anyOf 1) | string | Alternative | Default: null |
mapped_custom_column_id (anyOf 2) | null | Alternative | |
mapped_field | string | Required within parent | Must 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
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | |
mapped_custom_column_id | string | Required within parent | Identifier of the mapped purchase order custom field column. |
mapped_field | string | Required within parent | Maps 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
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | |
mapped_field | string | Required within parent | Must 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
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | |
mapped_field | string | Required within parent | Must 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
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | |
mapped_field | string | Required within parent | Must 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
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | |
value | string | Required 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
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
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | |
department_name | string | Required within parent | |
department_uuid | string | Required 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
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
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | |
allowed_file_types | JSON | Optional | |
allowed_file_types (anyOf 1) | array | Alternative | Default: null |
allowed_file_types (anyOf 1)[] | string | Each item | Known 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) | null | Alternative | |
comment | JSON | Optional | |
comment (anyOf 1) | string | Alternative | Default: null |
comment (anyOf 2) | null | Alternative | |
document_category | JSON | Optional | |
document_category (anyOf 1) | Model | Alternative | Expand 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) | null | Alternative | |
field_type | string | Required within parent | Must equal: FILE_UPLOAD |
mapped_fields | array | Optional | |
mapped_fields[] | Model | Each item | Expand Fetch a custom form 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 |
value | JSON | Required within parent | |
value (anyOf 1) | array | Alternative | |
value (anyOf 1)[] | Model | Each item | Expand Fetch a custom form 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) | null | Alternative | |
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
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
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | |
mapped_field | string | Required within parent | Must 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
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
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
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
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | |
comment | JSON | Optional | |
comment (anyOf 1) | string | Alternative | Default: null |
comment (anyOf 2) | null | Alternative | |
field_type | string | Required within parent | Must equal: MERCHANT |
mapped_fields | array | Optional | |
mapped_fields[] | JSON | Each item | discriminator: {"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) | Model | Alternative | Expand Fetch a custom form 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) | Model | Alternative | Expand Fetch a custom form 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) | Model | Alternative | Expand Fetch a custom form 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 |
value | JSON | Required within parent | |
value (anyOf 1) | array | Alternative | |
value (anyOf 1)[] | Model | Each item | Expand Fetch a custom form 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) | null | Alternative | |
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
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | |
comment | JSON | Optional | |
comment (anyOf 1) | string | Alternative | Default: null |
comment (anyOf 2) | null | Alternative | |
field_type | string | Required within parent | Must equal: MERCHANT_CATEGORY |
mapped_fields | array | Optional | |
mapped_fields[] | JSON | Each item | discriminator: {"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) | Model | Alternative | Expand Fetch a custom form 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) | Model | Alternative | Expand Fetch a custom form 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) | Model | Alternative | Expand Fetch a custom form 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 |
value | JSON | Required within parent | |
value (anyOf 1) | array | Alternative | |
value (anyOf 1)[] | Model | Each item | Expand Fetch a custom form 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) | null | Alternative | |
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
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
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | |
mapped_field | string | Required within parent | Must 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
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | |
mapped_field | string | Required within parent | Must 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
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | |
category_id | JSON | Required within parent | |
category_id (anyOf 1) | integer | Alternative | |
category_id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
category_name | string | Required 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
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
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | |
mapped_field | string | Required within parent | Must 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
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | |
mapped_field | string | Required within parent | Must 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
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | |
merchant_id | JSON | Required within parent | |
merchant_id (anyOf 1) | integer | Alternative | |
merchant_id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
merchant_name | string | Required 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
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
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | |
amount | JSON | Required within parent | |
amount (anyOf 1) | number | Alternative | Monetary amount in currency units (e.g. dollars, euros, etc.) |
amount (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
currency | string | Required within parent | Currency code |