Settings PATCH API Documentation

Purpose

This endpoint allows you to partially update an existing variation by modifying its core attributes (such as name, display_name, or description) or by performing operations on variation options (add, remove, or change). It provides flexibility for maintaining variation structures without recreating them from scratch.

Use Case

Updating the display name or description of a variation.
Reordering or renaming variation options.
Adding new variation options dynamically.
Removing outdated or invalid variation options.

Path Parameters

Parameter	Type	Description
`V_UUID`	String	Unique identifier of the variation to update.

Query Parameters

This endpoint does not have any query parameters.

Request Body

                V2
              

                V3
              

                      {
    "variations": {
        // "name": "",
        // "display_name": "",
        // "description": "hello",
        "options": [
            {
                "name": "Blue",
                "order": 1
                // "uuid": "2b39fcfa-8971-474b-bd78-ec285ebadb8a"
            },
            {
                "name": "Red",
                "order": 2
                // "uuid": "2b39fcfa-8971-474b-bd78-ec285ebadb8a"
            }
        ]
    }
}
                    

                      {
    "variations": {
        "name": "daviddof",
        "display_name": "dimention",
        "description": "Bryan Adams"
        // "options": [
        //     {
        //         "operation": "CHANGE",
        //         "name": "Ultra Pro Maxwell",
        //         "uuid": "c5f86f3b-be72-4268-8b31-e92752438760"
        //     },
        //     {
        //         "operation": "ADD",
        //         "name": "Maxwell"
        //     },
        //     {
        //         "operation": "REMOVE",
        //         "uuid": "c5f86f3b-be72-4268-8b31-e92752438760"
        //     }
        // ]
    }
}
                    

Attribute	Type	Description
`variations`	Object	Main container for variation update details.
`variations.name`	String	Internal system name for the variation (unique).
`variations.display_name`	String	Human-readable name of the variation.
`variations.description`	String	Description providing additional details about the variation.
`variations.options`	Array	List of operations to perform on variation options.
`variations.options[].operation`	String	Operation type: `ADD`, `REMOVE`, or `CHANGE`.
`variations.options[].name`	String	New or updated option name (used with `ADD` or `CHANGE`).
`variations.options[].uuid`	String	Unique identifier of the option to change or remove.

                V2
              

                V3
              

                      {
    "variation": {
        "uuid": "b68a94fb-f666-4a40-88a6-39460336352a",
        "status": "ACTIVE",
        "name": "daviddof",
        "display_name": "dimention",
        "description": "",
        "options": [
            {
                "name": "Ultra Pro Maxwell",
                "uuid": "06a1fdde-6ded-418c-b9a9-5b02219de095"
            },
            {
                "name": "Maxwell",
                "uuid": "1b139be5-e401-434b-9a8b-3be001f86bbd"
            },
            {
                "name": "Mobab",
                "uuid": "35233839-68b8-4738-b820-494d73be8c44"
            },
            {
                "name": "White",
                "uuid": "6bc69ee6-bddf-4b48-9f02-f5d26b552bb4"
            },
            {
                "name": "Red",
                "uuid": "c286caeb-a91b-4766-8d35-acebecd0973d"
            }
        ]
    }
}
                    

                      {
    "variation": {
        "uuid": "b68a94fb-f666-4a40-88a6-39460336352a",
        "status": "ACTIVE",
        "name": "daviddof",
        "display_name": "dimention",
        "description": "Bryan Adams",
        "options": [
            {
                "name": "Maxwell",
                "uuid": "1b139be5-e401-434b-9a8b-3be001f86bbd"
            },
            {
                "name": "Megular",
                "uuid": "6bc69ee6-bddf-4b48-9f02-f5d26b552bb4"
            },
            {
                "name": "Mobab",
                "uuid": "35233839-68b8-4738-b820-494d73be8c44"
            },
            {
                "name": "Qremium",
                "uuid": "c286caeb-a91b-4766-8d35-acebecd0973d"
            },
            {
                "name": "Ultra Pro Maxwell",
                "uuid": "06a1fdde-6ded-418c-b9a9-5b02219de095"
            }
        ]
    }
}
                    

Attribute	Type	Description
`variation`	Object	The updated variation object.
`variation.uuid`	String	Unique identifier of the variation.
`variation.status`	String	Status of the variation.
`variation.name`	String	Internal system name of the variation.
`variation.display_name`	String	Human-readable display name of the variation.
`variation.description`	String	Updated description of the variation.
`variation.options`	Array	List of options available under the variation.
`variation.options[].name`	String	Name of the variation option.
`variation.options[].uuid`	String	Unique identifier of the variation option.

Purpose

This API allows users to update the field-level settings for the Account entity within the system. It enables the customization of visibility, requirement, and default values of specific fields that define how account-related information is displayed and managed.

Use Case

To enable or disable specific fields in the Account module based on organizational policies.
To mark certain fields as required or optional during account creation or updates.
To define default values for fields such as payment terms, billing preferences, or payment modes.
To maintain consistent configuration across environments (example: staging, production).
To simplify user forms by disabling unused or irrelevant fields.

Path Parameters

This endpoint does not require any path parameters.

Query Parameters

This endpoint does not support any query parameters.

Request Body

                JSON
              

                      {
    "field_settings": {
        "account": {
            "fields": [
                {
                    "name": "FIELD_NAME",
                    "enabled": "BOOLEAN_VALUE",
                    "required": "BOOLEAN_VALUE",
                    "default": "DEFAULT_VALUE"
                }
            ]
        }
    }
}

                    

Attribute	Type	Description
field_settings	object	Contains the configuration object for all field settings.
field_settings.account	object	Contains the configuration for the Account entity’s fields.
fields	array	A list of field configuration objects specifying name, status, requirement, and default values.
fields.name	string	The internal name of the field being configured.
fields.enabled	boolean	Indicates whether the field should be enabled or disabled.
fields.required	boolean	Indicates whether the field is mandatory for data entry or optional.
fields.default	string	Defines the default value for the field, if applicable.

Response

The response confirms the successful update of the field settings for the Account entity. Upon success, a message is returned stating that the field configuration was updated. This ensures administrators receive confirmation that the applied field settings were saved and will take effect immediately in the system configuration.

Response Body

                JSON
              
                      {
    "message": "ENTITY_NAME - Field Setting has updated successfully"
}

Attribute	Type	Description
message	string	Confirmation message indicating that the account field settings were successfully updated.

Purpose

This API allows users to update and customize field-level settings for the Item entity in the system. It provides flexibility to control which item fields are enabled, required, and their associated default values. This is especially useful for tailoring item configuration forms and workflows in sales, purchase, and inventory modules.

Use Case

To enable or disable item-related fields according to module-specific business needs (Sales, Purchase, or Inventory).
To mark particular item fields as mandatory for data entry (example: accounting codes, payment modes).
To define default values for key configuration fields like billing periods, payment modes, or fulfillment terms.
To standardize field configurations across multiple environments such as development, staging, and production.
To improve data governance and reduce user input errors by automating field-level constraints.

Path Parameters

This endpoint does not require any path parameters.

Query Parameters

This endpoint does not accept any query parameters.

Request Body

                JSON
              

                      {
    "field_settings": {
        "item": {
            "fields": [
                {
                    "name": "FIELD_NAME",
                    "enabled": "BOOLEAN_VALUE",
                    "required": "BOOLEAN_VALUE",
                    "default": "DEFAULT_VALUE",
                    "module": "MODULE_NAME"
                }
            ]
        }
    }
}

                    

Attribute	Type	Description
field_settings	object	The parent object containing configuration details for field settings.
field_settings.item	object	Contains settings specific to the Item entity.
fields	array	A list of field configuration objects defining field-level behavior and rules.
fields.name	string	The internal system name of the item field.
fields.enabled	boolean	Specifies whether the field should be enabled or disabled.
fields.required	boolean	Defines whether the field is mandatory for data entry or optional.
fields.default	string	The default value to be assigned to the field.
fields.module	string	Identifies the module associated with the field.

Response

Upon successful execution, the API returns a confirmation message indicating that the Item field settings have been successfully updated. This ensures that the configuration applied to various item-related fields is now active in the system and will reflect in corresponding modules such as Sales or Purchase during item creation or updates. The response serves as a system acknowledgment of the configuration update.

Response Body

                JSON
              
                      {
    "message": "ENTITY_NAME - Field Setting has updated successfully"
}

Attribute	Type	Description
message	string	A success message confirming that the item field settings were updated successfully.

Purpose

This API allows users to update the Date and Time configuration under the system’s General Settings. It enables customization of time zone, date format, time format, and the first day of the week across the entire platform. By modifying these settings, organizations can ensure accurate timekeeping, region-specific display formats, and consistent scheduling behavior in reports, workflows, and time-based operations.

Use Case

To adjust the system time zone according to the company’s regional office or operational location.
To modify the date and time display format to comply with local or organizational standards.
To define which day should be treated as the first day of the week (example: Sunday or Monday) for calendars, reports, and scheduling modules.
To maintain consistency in time-sensitive processes across global teams operating in different time zones.
To align system-generated timestamps, reports, and automated actions with the preferred organizational format.

Path Parameters

This endpoint does not require any path parameters.

Query Parameters

This endpoint does not accept any query parameters.

Request Body

                JSON
              

                      {
    "general_settings": {
        "date_and_time": {
            "time_zone": "TIME_ZONE_PLACEHOLDER",
            "date_format": "DATE_FORMAT_PLACEHOLDER",
            "time_format": "TIME_FORMAT_PLACEHOLDER",
            "first_day_of_week": "FIRST_DAY_PLACEHOLDER"
        }
    }
}

                    

Attribute	Type	Description
general_settings	object	The parent object containing all system-wide general configuration settings.
general_settings.date_and_time	object	Holds configuration settings related to date and time formatting, time zone, and calendar setup.
time_zone	string	The system time zone identifier that determines how time is displayed and processed.
date_format	string	Defines the pattern for displaying dates across the platform.
time_format	string	Defines the pattern for displaying time values.
first_day_of_week	string	Specifies which day should be treated as the first day of the week.

Response

When the request is successfully processed, the system updates the general date and time configuration and returns a success message. The response indicates that the new settings are now active and applied globally across the platform. Any feature that depends on time calculations, date formatting, or calendar logic will automatically follow the updated configuration.

Response Body

                JSON
              
                      {
    "message": "Updated Object (settings.general_settings)"
}

Attribute	Type	Description
message	string	A confirmation message indicating that the general date and time settings were successfully updated.

Purpose

This API allows users to update the Account-related General Settings within the platform’s configuration module. It provides control over how accounts are created, grouped, managed, and validated. Through this endpoint, users can define account grouping rules, enable subsidiary account creation, assign default managers, and enforce validation rules for account and contact information. Additionally, it allows configuration of workflow approvals, referral tracking, and email uniqueness policies, ensuring compliance with business and operational requirements.

Use Case

To enable or disable account grouping and define a default account group.
To configure subsidiary account creation and assign default subsidiary accounts.
To assign a default account manager for newly created accounts.
To enable and configure referral or sales representative tracking at the account level.
To enforce or relax email and name uniqueness policies for accounts and contacts.
To manage billing, shipping, and additional contact configurations, including display names and email requirements.
To activate or deactivate workflow approval for account creation and updates.
To maintain uniform account management standards across different teams or departments.

Path Parameters

This endpoint does not require any path parameters.

Query Parameters

This endpoint does not support any query parameters.

Request Body

                JSON
              

                      {
    "general_settings": {
        "account": {
            "account_grouping": {
                "enabled": "BOOLEAN_PLACEHOLDER",
                "default_group": "DEFAULT_GROUP_PLACEHOLDER"
            },
            "creation_of_subsidiary_account": {
                "enabled": "BOOLEAN_PLACEHOLDER",
                "default_subsidiary_account": "DEFAULT_SUBSIDIARY_PLACEHOLDER"
            },
            "account_management": {
                "enabled": "BOOLEAN_PLACEHOLDER",
                "default_manager": "DEFAULT_MANAGER_PLACEHOLDER"
            },
            "referral_tracking_at_account_level": {
                "enabled": "BOOLEAN_PLACEHOLDER",
                "default_referral_tracking": "REFERRAL_TRACKING_PLACEHOLDER"
            },
            "sales_rep_tracking_at_account_level": {
                "enabled": "BOOLEAN_PLACEHOLDER",
                "default_sales_rep_tracking": "SALES_REP_EMAIL_PLACEHOLDER"
            },
            "enable_workflow_approval_for_account": "BOOLEAN_PLACEHOLDER",
            "require_name_to_be_unique": "BOOLEAN_PLACEHOLDER",
            "require_email_address_for_account": "BOOLEAN_PLACEHOLDER",
            "require_email_address_for_account_to_be_unique": "BOOLEAN_PLACEHOLDER",
            "require_email_address_for_contact_to_be_unique": "BOOLEAN_PLACEHOLDER",
            "billing_contact": {
                "enabled": "BOOLEAN_PLACEHOLDER",
                "type": "CONTACT_TYPE_PLACEHOLDER",
                "display_name": "BILLING_CONTACT_NAME_PLACEHOLDER",
                "require_email_address_for_billing_contact": "BOOLEAN_PLACEHOLDER"
            },
            "shipping_contact": {
                "enabled": "BOOLEAN_PLACEHOLDER",
                "type": "CONTACT_TYPE_PLACEHOLDER",
                "display_name": "SHIPPING_CONTACT_NAME_PLACEHOLDER",
                "require_email_address_for_shipping_contact": "BOOLEAN_PLACEHOLDER"
            },
            "additional_contact_1": {
                "enabled": "BOOLEAN_PLACEHOLDER",
                "type": "CONTACT_TYPE_PLACEHOLDER",
                "display_name": "ADDITIONAL_CONTACT_1_NAME_PLACEHOLDER",
                "require_email_address_for_additional_contact_1": "BOOLEAN_PLACEHOLDER"
            },
            "additional_contact_2": {
                "enabled": "BOOLEAN_PLACEHOLDER",
                "type": "CONTACT_TYPE_PLACEHOLDER",
                "display_name": "ADDITIONAL_CONTACT_2_NAME_PLACEHOLDER",
                "require_email_address_for_additional_contact_2": "BOOLEAN_PLACEHOLDER"
            },
            "additional_contact_3": {
                "enabled": "BOOLEAN_PLACEHOLDER",
                "display_name": "ADDITIONAL_CONTACT_3_NAME_PLACEHOLDER",
                "require_email_address_for_additional_contact_3": "BOOLEAN_PLACEHOLDER"
            }
        }
    }
}

                    

Attribute	Type	Description
general_settings	object	The root object containing all configurable general settings.
general_settings.account	object	Contains all settings related to account behavior and management.
account_grouping	object	Configuration for enabling or disabling account grouping and defining a default group.
creation_of_subsidiary_account	object	Controls the creation of subsidiary accounts and sets a default subsidiary.
account_management	object	Manages default account management preferences, including default manager assignment.
referral_tracking_at_account_level	object	Enables and defines referral tracking parameters at the account level.
sales_rep_tracking_at_account_level	object	Enables sales representative tracking and assigns a default sales representative.
enable_workflow_approval_for_account	string	Enables or disables workflow approval for account-related actions.
require_name_to_be_unique	string	Ensures that each account name within the system is unique when enabled.
require_email_address_for_account	string	Enforces that all accounts must include an email address when enabled.
require_email_address_for_account_to_be_unique	string	Enforces that each account email address must be unique.
require_email_address_for_contact_to_be_unique	string	Ensures that no two contacts share the same email address.
billing_contact	object	Configures the billing contact’s display name and email address requirements.
shipping_contact	object	Configures the shipping contact’s display name and email address requirements.
additional_contact_1	object	Configuration for an additional contact associated with the account.
additional_contact_2	object	Configuration for a second additional contact associated with the account.
additional_contact_3	object	Configuration for a third additional contact associated with the account.
enabled	string	Boolean-like string ("true" or "false") specifying if a setting is active.
type	string	Indicates the contact type (example: "Contact 1", "Contact 2").
display_name	string	Defines how the contact will be displayed in the system.
default_manager	string	The identifier or name of the default manager assigned to new accounts.
default_group	string	The default group assigned to new accounts when grouping is enabled.
default_subsidiary_account	string	The default subsidiary account assigned to sub-accounts when applicable.

Response

Upon successful request processing, the system updates the account-related general settings as specified in the payload. The response confirms that the configuration changes have been applied successfully. Any modules or workflows dependent on account settings (such as contact validation, workflow approvals, or account grouping) will now adhere to the updated rules.

Response Body

                JSON
              
                      {
    "message": "Updated Object (settings.general_settings)"
}

Attribute	Type	Description
message	string	A confirmation message indicating that the general account settings have been successfully updated.

Purpose

This API allows users to update the Item-related General Settings under the platform’s configuration module. It provides centralized control over how items are created, managed, priced, and integrated into workflows such as purchasing, sales, and inventory management. Through this endpoint, users can enable various item types, configure pricing and tax settings, activate inventory control, and set rules for serialization, batching, and stock handling, all tailored to the organization’s operational needs.

Use Case

To enable or disable different item types such as variation-based, bundled, direct-cost, or fixed-asset items.
To define item grouping rules and assign default item managers.
To control volume pricing, pricing profiles, and workflow approvals for items.
To configure sales-related settings, such as available charge types (one-off, recurring, metered) and pricing inclusivity with tax.
To enable and manage purchase, supplier, and inventory settings, including warehouse management and adjustment rules.
To control inventory costing, serialization, and batch tracking for precise stock management.
To establish rules for pre-orders, back-orders, and stock determination criteria.

Path Parameters

This endpoint does not require any path parameters.

Query Parameters

This endpoint does not support any query parameters.

Request Body

                JSON
              

                      {
    "general_settings": {
        "item": {
            "enable_variation_based_item": "BOOLEAN_PLACEHOLDER",
            "enable_gift_certificate_based_item": "BOOLEAN_PLACEHOLDER",
            "enable_bundle_item": "BOOLEAN_PLACEHOLDER",
            "enable_direct_cost_item": "BOOLEAN_PLACEHOLDER",
            "enable_fixed_asset_item": "BOOLEAN_PLACEHOLDER",
            "enable_family_cost_item": "BOOLEAN_PLACEHOLDER",
            "require_name_to_be_unique": "BOOLEAN_PLACEHOLDER",
            "enable_variation": "BOOLEAN_PLACEHOLDER",
            "item_grouping": {
                "enabled": "BOOLEAN_PLACEHOLDER",
                "default_group": "DEFAULT_ITEM_GROUP_PLACEHOLDER"
            },
            "item_management": {
                "enabled": "BOOLEAN_PLACEHOLDER",
                "default_manager": "DEFAULT_MANAGER_PLACEHOLDER"
            },
            "use_volume_pricing": {
                "enabled": "BOOLEAN_PLACEHOLDER",
                "all_units_fixed_pricing": "BOOLEAN_PLACEHOLDER",
                "incremental_fixed_pricing": "BOOLEAN_PLACEHOLDER",
                "all_units_per_unit_pricing": "BOOLEAN_PLACEHOLDER",
                "incremental_per_unit_pricing": "BOOLEAN_PLACEHOLDER"
            },
            "enable_pricing_profile": "BOOLEAN_PLACEHOLDER",
            "enable_workflow_approval_for_item": "BOOLEAN_PLACEHOLDER",
            "enable_sales": "BOOLEAN_PLACEHOLDER",
            "available_charge_types": {
                "one_off": "BOOLEAN_PLACEHOLDER",
                "recurring": "BOOLEAN_PLACEHOLDER",
                "metered": "BOOLEAN_PLACEHOLDER"
            },
            "use_on_sale_price": "BOOLEAN_PLACEHOLDER",
            "use_shipping_profile": "BOOLEAN_PLACEHOLDER",
            "use_pricing_level": "BOOLEAN_PLACEHOLDER",
            "use_scheduling_of_future_pricing": "BOOLEAN_PLACEHOLDER",
            "charging_period_can_vary_from_billing_period": "BOOLEAN_PLACEHOLDER",
            "charging_start_date_can_vary_from_billing_start_date": "BOOLEAN_PLACEHOLDER",
            "pricing_period_can_vary_from_charging_period": {
                "enabled": "BOOLEAN_PLACEHOLDER",
                "default_pricing_period": "DEFAULT_PERIOD_PLACEHOLDER"
            },
            "sale_price_entered_is_inclusive_of_tax": {
                "enabled": "BOOLEAN_PLACEHOLDER",
                "tax_included_in_sales_price_is_based_on": "TAX_BASIS_PLACEHOLDER"
            },
            "available_pricing_methods": {
                "standard": "BOOLEAN_PLACEHOLDER",
                "discount_based": "BOOLEAN_PLACEHOLDER",
                "markup_based": "BOOLEAN_PLACEHOLDER"
            },
            "enable_purchase": "BOOLEAN_PLACEHOLDER",
            "enable_supplier_management": "BOOLEAN_PLACEHOLDER",
            "purchase_price_entered_is_inclusive_of_tax": {
                "enabled": "BOOLEAN_PLACEHOLDER",
                "tax": {
                    "uuid": "TAX_UUID_PLACEHOLDER"
                }
            },
            "enable_inventory_management": "BOOLEAN_PLACEHOLDER",
            "enable_warehouse_management": "BOOLEAN_PLACEHOLDER",
            "inventory_adjustment_rules": {
                "quantity_available_for_sale_determination": [
                    "QUANTITY_DETERMINATION_PLACEHOLDER_1",
                    "QUANTITY_DETERMINATION_PLACEHOLDER_2"
                ],
                "quantity_available_for_sale": "QUANTITY_AVAILABLE_PLACEHOLDER"
            },
            "pre_order": {
                "enabled": "BOOLEAN_PLACEHOLDER",
                "period": "PERIOD_TYPE_PLACEHOLDER",
                "number_of_period": "NUMBER_OF_PERIOD_PLACEHOLDER"
            },
            "enable_serialization": "BOOLEAN_PLACEHOLDER",
            "enable_batch_tracking": "BOOLEAN_PLACEHOLDER",
            "enable_inventory_costing": "BOOLEAN_PLACEHOLDER",
            "enable_back_order": "BOOLEAN_PLACEHOLDER"
        }
    }
}

                    

Attribute	Type	Description
general_settings	object	The root object containing all general configuration settings.
general_settings.item	object	Holds all configurable options related to item management.
enable_variation_based_item	string	Enables creation and management of variation-based items.
enable_gift_certificate_based_item	string	Enables items categorized as gift certificates.
enable_bundle_item	string	Allows creation of bundled or composite items.
enable_direct_cost_item	string	Enables tracking of items that are directly costed.
enable_fixed_asset_item	string	Enables tracking of items categorized as fixed assets.
enable_family_cost_item	string	Allows grouping of item costs by family or type.
require_name_to_be_unique	string	Enforces uniqueness of item names across the system.
enable_variation	string	Enables variation functionality (requires variation-based items to be enabled).
item_grouping	object	Configures item grouping and defines a default group.
item_management	object	Configures default item manager and management behavior.
use_volume_pricing	object	Enables and defines rules for volume-based pricing models.
enable_pricing_profile	string	Enables the use of predefined pricing profiles for items.
enable_workflow_approval_for_item	string	Enables workflow approval requirements for item-related operations.
enable_sales	string	Enables items to be used in sales transactions.
available_charge_types	object	Defines the charge types available for items (one-off, recurring, metered).
use_on_sale_price	string	Enables the system to use a defined sale price for discounted items.
use_shipping_profile	string	Enables items to use predefined shipping profiles.
use_pricing_level	string	Enables pricing level configurations for tiered pricing strategies.
use_scheduling_of_future_pricing	string	Allows scheduling of future item pricing updates.
charging_period_can_vary_from_billing_period	string	Allows charging period to differ from billing period.
charging_start_date_can_vary_from_billing_start_date	string	Allows variation between charging and billing start dates.
pricing_period_can_vary_from_charging_period	object	Enables flexibility between pricing and charging periods.
sale_price_entered_is_inclusive_of_tax	object	Defines whether the sale price includes tax and what tax basis is used.
available_pricing_methods	object	Specifies allowed pricing calculation methods (standard, discount, markup).
enable_purchase	string	Enables purchase functionality for items.
enable_supplier_management	string	Enables supplier management features for item purchases.
purchase_price_entered_is_inclusive_of_tax	object	Defines tax inclusivity for purchase prices and assigns a tax configuration.
enable_inventory_management	string	Enables inventory tracking for items.
enable_warehouse_management	string	Enables warehouse-level management for inventory.
inventory_adjustment_rules	object	Defines rules for determining and adjusting available quantities for sale.
pre_order	object	Configures pre-order availability and duration settings.
enable_serialization	string	Enables serial number tracking for items.
enable_batch_tracking	string	Enables batch or lot tracking for inventory.
enable_inventory_costing	string	Enables cost tracking for inventory items.
enable_back_order	string	Enables creation of back orders when stock is unavailable.

Response

Once the API request is successfully processed, the system updates the general item settings as specified. The response confirms that all applicable configuration values have been successfully stored. These settings directly influence item behavior across the platform including item creation, pricing application, stock handling, purchase and sales workflows, and overall inventory management.

Response Body

                JSON
              
                      {
    "message": "Updated Object (settings.general_settings)"
}

Update a Specific Variation: /settings/variations/{V_UUID}

Purpose

Use Case

Path Parameters

Query Parameters

Request Body

Response

Response Body

Update Account Field Settings: /settings/field_settings/account

Purpose

Use Case

Path Parameters

Query Parameters

Request Body

Response

Response Body

Update Item Field Settings: /settings/field_settings/item

Purpose

Use Case

Path Parameters

Query Parameters

Request Body

Response

Response Body

Update General Settings for Date and Time: /settings/general_settings/date_and_time

Purpose

Use Case

Path Parameters

Query Parameters

Request Body

Response

Response Body

Update General Account Settings: /settings/general_settings/account

Purpose

Use Case

Path Parameters

Query Parameters

Request Body

Response

Response Body

Update General Item Settings: /settings/general_settings/item

Purpose

Use Case

Path Parameters

Query Parameters

Request Body

Response

Response Body