cURL
curl -X PATCH "$EXSITED_BASE_URL/api/v4/settings/general_settings/item" \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"general_settings": {
"item": {
"available_pricing_methods": {
"markup_based": "true"
},
"charging_period_can_vary_from_billing_period": "false"
}
}
}'from exsited import build_client
client = build_client()
response = client.settings.update_settings_general_settings_item(
{
"general_settings": {
"item": {
"available_pricing_methods": {"markup_based": "true"},
"charging_period_can_vary_from_billing_period": "false",
}
}
}
)
print(response.data)
import {buildClient} from 'exsited';
const client = await buildClient();
const response = await client.settings.updateSettingsGeneralSettingsItem({
general_settings: {
item: {
available_pricing_methods: {markup_based: 'true'},
charging_period_can_vary_from_billing_period: 'false',
},
},
});
console.log(response.data);
use Exsited\Client\ClientRegistry;
$client = ClientRegistry::buildClient();
$response = $client->settings->updateSettingsGeneralSettingsItem([
'general_settings' => [
'item' => [
'available_pricing_methods' => ['markup_based' => 'true'],
'charging_period_can_vary_from_billing_period' => 'false',
],
],
]);
print_r($response->data);
import com.exsited.client.ApiResponse;
import com.exsited.client.ClientRegistry;
import com.exsited.client.ExsitedClient;
import com.exsited.resources.settings.settings_dto.SettingsDto.SettingsGeneralSettingsItemUpdated;
import java.util.Map;
ExsitedClient client = ClientRegistry.buildClient();
ApiResponse<SettingsGeneralSettingsItemUpdated> response = client.settings().updateSettingsGeneralSettingsItem(
Map.of(
"general_settings", Map.of(
"item", Map.of(
"available_pricing_methods", Map.of("markup_based", "true"),
"charging_period_can_vary_from_billing_period", "false"))));
System.out.println(response.getMap());
using Exsited.Client;
await using var client = ExsitedClient.BuildClient();
var response = await client.Settings.UpdateSettingsGeneralSettingsItemAsync(new Dictionary<string, object?>
{
["general_settings"] = new Dictionary<string, object?>
{
["item"] = new Dictionary<string, object?>
{
["available_pricing_methods"] = new Dictionary<string, object?>
{
["markup_based"] = "true",
},
["charging_period_can_vary_from_billing_period"] = "false",
},
},
});
Console.WriteLine(response.Json);
import 'package:exsited/exsited.dart';
final client = buildClient();
final response = await client.settings.updateSettingsGeneralSettingsItem({
'general_settings': {
'item': {
'available_pricing_methods': {'markup_based': 'true'},
'charging_period_can_vary_from_billing_period': 'false',
},
},
});
print(response.map);
import (
"context"
"fmt"
"log"
exsited "github.com/exsited/exsited-sdk-go/v4"
)
client, err := exsited.BuildClient(nil)
if err != nil {
log.Fatal(err)
}
defer client.Close()
response, err := client.Settings().UpdateSettingsGeneralSettingsItem(context.Background(), map[string]any{
"general_settings": map[string]any{
"item": map[string]any{
"available_pricing_methods": map[string]any{"markup_based": "true"},
"charging_period_can_vary_from_billing_period": "false",
},
},
}, nil)
if err != nil {
log.Fatal(err)
}
fmt.Println(response.Map)
{
"general_settings": {
"item": {
"available_charge_types": {
"metered": "<string>",
"one_off": "<string>",
"recurring": "<string>"
},
"available_pricing_methods": {
"discount_based": "<string>",
"markup_based": "<string>",
"standard": "<string>"
},
"charging_period_can_vary_from_billing_period": "<string>",
"charging_start_date_can_vary_from_billing_start_date": "<string>",
"enable_back_order": "<string>",
"enable_batch_tracking": "<string>",
"enable_bundle_item": "<string>",
"enable_direct_cost_item": "<string>",
"enable_family_cost_item": "<string>",
"enable_fixed_asset_item": "<string>",
"enable_gift_certificate_based_item": "<string>",
"enable_inventory_costing": "<string>",
"enable_inventory_management": "<string>",
"enable_pricing_profile": "<string>",
"enable_purchase": "<string>",
"enable_sales": "<string>",
"enable_serialization": "<string>",
"enable_supplier_management": "<string>",
"enable_variation": "<string>",
"enable_variation_based_item": "<string>",
"enable_warehouse_management": "<string>",
"enable_workflow_approval_for_item": "<string>",
"inventory_adjustment_rules": {
"quantity_available_for_sale": "<string>",
"quantity_available_for_sale_determination": "<string>"
},
"item_grouping": {
"default_group": "<unknown>",
"enabled": "<string>"
},
"item_management": {
"default_manager": "<unknown>",
"enabled": "<string>"
},
"pre_order": {
"enabled": "<string>",
"number_of_period": "<string>",
"period": "<string>"
},
"pricing_period_can_vary_from_charging_period": {
"default_pricing_period": "<unknown>",
"enabled": "<string>"
},
"purchase_price_entered_is_inclusive_of_tax": {
"enabled": "<string>",
"tax": {
"uuid": "<string>"
}
},
"require_name_to_be_unique": "<string>",
"sale_price_entered_is_inclusive_of_tax": {
"enabled": "<string>",
"tax": "<unknown>",
"tax_included_in_sales_price_is_based_on": "<string>"
},
"use_on_sale_price": "<string>",
"use_pricing_level": "<string>",
"use_scheduling_of_future_pricing": "<string>",
"use_shipping_profile": "<string>",
"use_volume_pricing": {
"all_units_fixed_pricing": "<string>",
"all_units_per_unit_pricing": "<string>",
"enabled": "<string>",
"incremental_fixed_pricing": "<string>",
"incremental_per_unit_pricing": "<string>"
}
},
"product": {
"allow_item_sell_multi_quantity": "<string>",
"allow_plan_sell_multi_quantity": "<string>",
"allow_product_sell_multi_quantity": "<string>",
"allow_rate_sell_multi_quantity": "<string>",
"item_quantity_use": "<string>",
"plan_quantity_use": "<string>",
"product_quantity_use": "<string>",
"rate_quantity_use": "<string>"
}
}
}Instance settings
Update item general settings
Changes settings in the item group of general settings and returns the item and product settings.
PATCH
/
settings
/
general_settings
/
item
cURL
curl -X PATCH "$EXSITED_BASE_URL/api/v4/settings/general_settings/item" \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"general_settings": {
"item": {
"available_pricing_methods": {
"markup_based": "true"
},
"charging_period_can_vary_from_billing_period": "false"
}
}
}'from exsited import build_client
client = build_client()
response = client.settings.update_settings_general_settings_item(
{
"general_settings": {
"item": {
"available_pricing_methods": {"markup_based": "true"},
"charging_period_can_vary_from_billing_period": "false",
}
}
}
)
print(response.data)
import {buildClient} from 'exsited';
const client = await buildClient();
const response = await client.settings.updateSettingsGeneralSettingsItem({
general_settings: {
item: {
available_pricing_methods: {markup_based: 'true'},
charging_period_can_vary_from_billing_period: 'false',
},
},
});
console.log(response.data);
use Exsited\Client\ClientRegistry;
$client = ClientRegistry::buildClient();
$response = $client->settings->updateSettingsGeneralSettingsItem([
'general_settings' => [
'item' => [
'available_pricing_methods' => ['markup_based' => 'true'],
'charging_period_can_vary_from_billing_period' => 'false',
],
],
]);
print_r($response->data);
import com.exsited.client.ApiResponse;
import com.exsited.client.ClientRegistry;
import com.exsited.client.ExsitedClient;
import com.exsited.resources.settings.settings_dto.SettingsDto.SettingsGeneralSettingsItemUpdated;
import java.util.Map;
ExsitedClient client = ClientRegistry.buildClient();
ApiResponse<SettingsGeneralSettingsItemUpdated> response = client.settings().updateSettingsGeneralSettingsItem(
Map.of(
"general_settings", Map.of(
"item", Map.of(
"available_pricing_methods", Map.of("markup_based", "true"),
"charging_period_can_vary_from_billing_period", "false"))));
System.out.println(response.getMap());
using Exsited.Client;
await using var client = ExsitedClient.BuildClient();
var response = await client.Settings.UpdateSettingsGeneralSettingsItemAsync(new Dictionary<string, object?>
{
["general_settings"] = new Dictionary<string, object?>
{
["item"] = new Dictionary<string, object?>
{
["available_pricing_methods"] = new Dictionary<string, object?>
{
["markup_based"] = "true",
},
["charging_period_can_vary_from_billing_period"] = "false",
},
},
});
Console.WriteLine(response.Json);
import 'package:exsited/exsited.dart';
final client = buildClient();
final response = await client.settings.updateSettingsGeneralSettingsItem({
'general_settings': {
'item': {
'available_pricing_methods': {'markup_based': 'true'},
'charging_period_can_vary_from_billing_period': 'false',
},
},
});
print(response.map);
import (
"context"
"fmt"
"log"
exsited "github.com/exsited/exsited-sdk-go/v4"
)
client, err := exsited.BuildClient(nil)
if err != nil {
log.Fatal(err)
}
defer client.Close()
response, err := client.Settings().UpdateSettingsGeneralSettingsItem(context.Background(), map[string]any{
"general_settings": map[string]any{
"item": map[string]any{
"available_pricing_methods": map[string]any{"markup_based": "true"},
"charging_period_can_vary_from_billing_period": "false",
},
},
}, nil)
if err != nil {
log.Fatal(err)
}
fmt.Println(response.Map)
{
"general_settings": {
"item": {
"available_charge_types": {
"metered": "<string>",
"one_off": "<string>",
"recurring": "<string>"
},
"available_pricing_methods": {
"discount_based": "<string>",
"markup_based": "<string>",
"standard": "<string>"
},
"charging_period_can_vary_from_billing_period": "<string>",
"charging_start_date_can_vary_from_billing_start_date": "<string>",
"enable_back_order": "<string>",
"enable_batch_tracking": "<string>",
"enable_bundle_item": "<string>",
"enable_direct_cost_item": "<string>",
"enable_family_cost_item": "<string>",
"enable_fixed_asset_item": "<string>",
"enable_gift_certificate_based_item": "<string>",
"enable_inventory_costing": "<string>",
"enable_inventory_management": "<string>",
"enable_pricing_profile": "<string>",
"enable_purchase": "<string>",
"enable_sales": "<string>",
"enable_serialization": "<string>",
"enable_supplier_management": "<string>",
"enable_variation": "<string>",
"enable_variation_based_item": "<string>",
"enable_warehouse_management": "<string>",
"enable_workflow_approval_for_item": "<string>",
"inventory_adjustment_rules": {
"quantity_available_for_sale": "<string>",
"quantity_available_for_sale_determination": "<string>"
},
"item_grouping": {
"default_group": "<unknown>",
"enabled": "<string>"
},
"item_management": {
"default_manager": "<unknown>",
"enabled": "<string>"
},
"pre_order": {
"enabled": "<string>",
"number_of_period": "<string>",
"period": "<string>"
},
"pricing_period_can_vary_from_charging_period": {
"default_pricing_period": "<unknown>",
"enabled": "<string>"
},
"purchase_price_entered_is_inclusive_of_tax": {
"enabled": "<string>",
"tax": {
"uuid": "<string>"
}
},
"require_name_to_be_unique": "<string>",
"sale_price_entered_is_inclusive_of_tax": {
"enabled": "<string>",
"tax": "<unknown>",
"tax_included_in_sales_price_is_based_on": "<string>"
},
"use_on_sale_price": "<string>",
"use_pricing_level": "<string>",
"use_scheduling_of_future_pricing": "<string>",
"use_shipping_profile": "<string>",
"use_volume_pricing": {
"all_units_fixed_pricing": "<string>",
"all_units_per_unit_pricing": "<string>",
"enabled": "<string>",
"incremental_fixed_pricing": "<string>",
"incremental_per_unit_pricing": "<string>"
}
},
"product": {
"allow_item_sell_multi_quantity": "<string>",
"allow_plan_sell_multi_quantity": "<string>",
"allow_product_sell_multi_quantity": "<string>",
"allow_rate_sell_multi_quantity": "<string>",
"item_quantity_use": "<string>",
"plan_quantity_use": "<string>",
"product_quantity_use": "<string>",
"rate_quantity_use": "<string>"
}
}
}Send the settings to change under
general_settings.item, such as available_pricing_methods.markup_based or charging_period_can_vary_from_billing_period. Values are strings such as "true" and "false". The response holds item and product under general_settings.
The SDK samples get their client from credentials your app registers once when it starts, as shown in Authentication. To try the call here, click Try it, set
host to your Exsited API host name and paste an access token from Get an access token. To send a raw JSON body instead of filling in fields, copy the cURL sample and edit its -d payload.Authorizations
An access token from POST /api/v4/oauth2/token. The SDKs get and renew it for you.
Body
application/json
Show child attributes
Show child attributes
Response
200 - application/json
The item and product settings, under general_settings.
Show child attributes
Show child attributes