customFields

Create a custom field

Requires the CUSTOM_FIELD.CREATE permission.

post/v{version}/custom-fields

Request

  • Base URL: https://test.api.solvimon.com
  • URL: https://test.api.solvimon.com/v{version}/custom-fields
  • Auth: API key in header X-API-KEY

Path parameters

versionstring required

version

Headers

x-platform-idstring

Platform ID.

Request body

object_typestring nullable
idstring nullable
referencestring required
namestring nullable
descriptionstring nullable
resource_type'PLATFORM' | 'CUSTOMER' | 'BILLING_ENTITY' | 'METER' | 'METER_VALUE' | 'METER_PROPERTY' | 'METER_VALUE_CALCULATION' | 'PRODUCT' | 'PRODUCT_ITEM' | 'PRODUCT_CATEGORY' | 'PRICING' | 'PRICING_ITEM' | 'PRICING_ITEM_CONFIG' | 'PRICING_ITEM_SUMMARY' | 'METER_VALUE_CALCULATION_SUMMARY' | 'PRICING_PLAN' | 'PRICING_PLAN_VERSION' | 'PRICING_PLAN_SUBSCRIPTION' | 'PRICING_PLAN_SCHEDULE' | 'QUOTE' | 'QUOTE_VERSION' | 'CONTACT' | 'CUSTOM_FIELD' | 'REQUEST_REFERENCE' | 'METER_DATA' | 'CHARGE_DATA' | 'ADJUSTMENT_DATA' | 'PERSIST_DATA' | 'INVOICE' | 'INVOICE_PAYMENT_ATTEMPT' | 'PAYMENT_ACCEPTOR' | 'PAYMENT_SCHEDULE' | 'PAYMENT_REQUEST' | 'FEATURE' | 'ALERT_RULE' | 'ALERT' | 'USER' | 'MEMBERSHIP' | 'TEAM' | 'ENTITY' | 'ACCOUNT_GROUP' | 'AUDIT' | 'WEBHOOK' | 'REPORT_SUBSCRIPTION' | 'REPORT_CONFIGURATION' required
multiple_valuesboolean nullable
unique_valueboolean nullable
copy_value_to_invoiceboolean nullable
integration_idstring

The resource ID of the integration linked to this custom field.

integration_referencestring nullable

The reference of the integration linked to this custom field. Read-only, and only present when the custom field is linked to an integration.

integration_typestring nullable

The type of the integration linked to this custom field. Read-only, and only present when the custom field is linked to an integration.

type'STRING' | 'NUMBER' | 'BOOLEAN' | 'ENUM'
enum_valuesstring[] nullable

Response

Created

object_typestring nullable
idstring nullable
referencestring
namestring nullable
descriptionstring nullable
resource_type'PLATFORM' | 'CUSTOMER' | 'BILLING_ENTITY' | 'METER' | 'METER_VALUE' | 'METER_PROPERTY' | 'METER_VALUE_CALCULATION' | 'PRODUCT' | 'PRODUCT_ITEM' | 'PRODUCT_CATEGORY' | 'PRICING' | 'PRICING_ITEM' | 'PRICING_ITEM_CONFIG' | 'PRICING_ITEM_SUMMARY' | 'METER_VALUE_CALCULATION_SUMMARY' | 'PRICING_PLAN' | 'PRICING_PLAN_VERSION' | 'PRICING_PLAN_SUBSCRIPTION' | 'PRICING_PLAN_SCHEDULE' | 'QUOTE' | 'QUOTE_VERSION' | 'CONTACT' | 'CUSTOM_FIELD' | 'REQUEST_REFERENCE' | 'METER_DATA' | 'CHARGE_DATA' | 'ADJUSTMENT_DATA' | 'PERSIST_DATA' | 'INVOICE' | 'INVOICE_PAYMENT_ATTEMPT' | 'PAYMENT_ACCEPTOR' | 'PAYMENT_SCHEDULE' | 'PAYMENT_REQUEST' | 'FEATURE' | 'ALERT_RULE' | 'ALERT' | 'USER' | 'MEMBERSHIP' | 'TEAM' | 'ENTITY' | 'ACCOUNT_GROUP' | 'AUDIT' | 'WEBHOOK' | 'REPORT_SUBSCRIPTION' | 'REPORT_CONFIGURATION'
multiple_valuesboolean nullable
unique_valueboolean nullable
copy_value_to_invoiceboolean nullable
integration_idstring

The resource ID of the integration linked to this custom field.

integration_referencestring nullable

The reference of the integration linked to this custom field. Read-only, and only present when the custom field is linked to an integration.

integration_typestring nullable

The type of the integration linked to this custom field. Read-only, and only present when the custom field is linked to an integration.

type'STRING' | 'NUMBER' | 'BOOLEAN' | 'ENUM'
enum_valuesstring[] nullable

Changes

No recorded changes to this operation across all 1 revision of this API.