PriceList RoundingRule
/
Get a rounding rule by id

Management API (v1)

The Norce Management API lets you manage configurations and metadata on a client.

Download OpenAPI description
openapi.json
openapi.yaml
Languages
Servers

https://customer-slug.api-se.playground.norce.tech/commerce/management/1.0/

Schemas

Settings ApplicationCountry

Operations

Settings ApplicationCulture

Operations

Settings ApplicationCurrency

Operations

Settings ApplicationSalesArea

Operations

Settings Application

Operations

Category

Operations

CategoryParametric

Operations

Settings ClientAssortment

Operations

Settings ClientCurrency

Operations

Settings ClientSalesArea

Operations

Customer FlagGroup

Operations

Customer Flag

Operations

Customer InfoType

Operations

Product Family

Operations

Product File

Operations

Product Manufacturer

Operations

Parametric Group

Operations

Parametric List

Operations

Parametric Multiple

Operations

Parametric

Operations

PriceList Population

Operations

PriceList Pricing

Operations

PriceList

Operations

PriceList SupplierPriceList

Operations

PriceList Warehouse

Operations

Product FlagGroup

Operations

Product Flag

Operations

Product InfoType

Operations

Product Type

Operations

Promotion

Operations

Product RelationType

Operations

PriceList RoundingRule

Operations

Get a rounding rule by id

Request

Get a specific rounding rule by its internal id

Path
idinteger(int32)required

Rounding rule id

Headers
account-idintegerrequired

User Account ID

application-idintegerrequired

Application ID

curl -i -X GET \
  'https://customer-slug.api-se.playground.norce.tech/commerce/management/1.0/api/pricing/roundingrule/{id}' \
  -H 'account-id: 0' \
  -H 'application-id: 0'

Responses

Returns the RoundingRule

Bodyapplication/json
Idinteger(int32)

The rounding rule identifier

TypeIdinteger or null(int32)

Optional price list type identifier

TypeNamestring or null

Optional name of the price list type

CurrencyIdinteger or null(int32)

Optional currency identifier, if the rounding rule is currency specific

CurrencyCodestring or null

Optional currency code, if the rounding rule is currency specific

CurrencyNamestring or null

Optional currency name, if the rounding rule is currency specific

ApplicationIdinteger or null(int32)

Optional application identifier, applies to price lists that are public on a specific application.

ApplicationNamestring or null

Optional application name

FieldIdinteger or null(int32)

Optional field identifier, if the rounding rule is specific to a certain field. Allowed values are: null (not field specific), 1 (Sale Price), 2 (Recommended Price), 3 (Catalog Price)

FieldNamestring or null

Optional field name, if the rounding rule is specific to a certain field.

DefaultNamestring or null[ 0 .. 255 ] characters

The name of the rounding rule for the default language.

DefaultDescriptionstring or null

The description of the rounding rule for the default language.

IsIncludingVatboolean or null

Indicates whether the rounding rule is applied on amounts including VAT or excluding VAT

IsMinimumMarginForcedboolean

Indicates how the rounding rules should adhere to minimum margin settings. If true, minimum margin fallbacks are forced after rounding, which may override rounding results.

TestDataArray of objects or null(RoundingTestPair)

Test data for validating rounding rule calculations, used in administration UI

IsActiveboolean

Indicates whether the rounding rule is active

Changedstring or null

The date and time the rounding rule was last changed

ChangedBystring or null

Fullname or Systemname of the user who last changed the rounding rule

SettingsArray of objects or null(RoundingRuleSettingModel)

The list of rounding rule settings that define specific rounding criteria

RoundingRuleSettingArray of objects or null(IRoundingRuleSetting)
Response
application/json
{
  "Id": 0,
  "TypeId": 0,
  "TypeName": "string",
  "CurrencyId": 0,
  "CurrencyCode": "string",
  "CurrencyName": "string",
  "ApplicationId": 0,
  "ApplicationName": "string",
  "FieldId": 0,
  "FieldName": "string",
  "DefaultName": "string",
  "DefaultDescription": "string",
  "IsIncludingVat": true,
  "IsMinimumMarginForced": true,
  "TestData": [
    { … }
  ],
  "IsActive": true,
  "Changed": "string",
  "ChangedBy": "string",
  "Settings": [
    { … }
  ],
  "RoundingRuleSetting": [
    { … }
  ]
}

Update a rounding rule

Request

Update an existing rounding rule

Path
idinteger(int32)required

Rounding rule id

Headers
account-idintegerrequired

User Account ID

application-idintegerrequired

Application ID

Bodyapplication/jsonrequired

Rounding rule to update

Idinteger(int32)

The rounding rule identifier

TypeIdinteger or null(int32)

Optional price list type identifier

TypeNamestring or null

Optional name of the price list type

CurrencyIdinteger or null(int32)

Optional currency identifier, if the rounding rule is currency specific

CurrencyCodestring or null

Optional currency code, if the rounding rule is currency specific

CurrencyNamestring or null

Optional currency name, if the rounding rule is currency specific

ApplicationIdinteger or null(int32)

Optional application identifier, applies to price lists that are public on a specific application.

ApplicationNamestring or null

Optional application name

FieldIdinteger or null(int32)

Optional field identifier, if the rounding rule is specific to a certain field. Allowed values are: null (not field specific), 1 (Sale Price), 2 (Recommended Price), 3 (Catalog Price)

FieldNamestring or null

Optional field name, if the rounding rule is specific to a certain field.

DefaultNamestring or null[ 0 .. 255 ] characters

The name of the rounding rule for the default language.

DefaultDescriptionstring or null

The description of the rounding rule for the default language.

IsIncludingVatboolean or null

Indicates whether the rounding rule is applied on amounts including VAT or excluding VAT

IsMinimumMarginForcedboolean

Indicates how the rounding rules should adhere to minimum margin settings. If true, minimum margin fallbacks are forced after rounding, which may override rounding results.

TestDataArray of objects or null(RoundingTestPair)

Test data for validating rounding rule calculations, used in administration UI

IsActiveboolean

Indicates whether the rounding rule is active

Changedstring or null

The date and time the rounding rule was last changed

ChangedBystring or null

Fullname or Systemname of the user who last changed the rounding rule

SettingsArray of objects or null(RoundingRuleSettingModel)

The list of rounding rule settings that define specific rounding criteria

RoundingRuleSettingArray of objects or null(IRoundingRuleSetting)
curl -i -X PUT \
  'https://customer-slug.api-se.playground.norce.tech/commerce/management/1.0/api/pricing/roundingrule/{id}' \
  -H 'Content-Type: application/json' \
  -H 'account-id: 0' \
  -H 'application-id: 0' \
  -d '{
    "Id": 0,
    "TypeId": 0,
    "TypeName": "string",
    "CurrencyId": 0,
    "CurrencyCode": "string",
    "CurrencyName": "string",
    "ApplicationId": 0,
    "ApplicationName": "string",
    "FieldId": 0,
    "FieldName": "string",
    "DefaultName": "string",
    "DefaultDescription": "string",
    "IsIncludingVat": true,
    "IsMinimumMarginForced": true,
    "TestData": [
      {
        "Price": 0,
        "Rounded": 0
      }
    ],
    "IsActive": true,
    "Changed": "string",
    "ChangedBy": "string",
    "Settings": [
      {
        "Id": 0,
        "RuleId": 0,
        "PriceFrom": 0,
        "PriceTo": 0,
        "PriceEndsFrom": 0,
        "PriceEndsTo": 0,
        "RoundToDecimals": 0,
        "RoundingDirection": 0,
        "RoundingValue": 0,
        "Changed": "string",
        "ChangedBy": "string"
      }
    ],
    "RoundingRuleSetting": [
      {
        "Id": 0,
        "RuleId": 0,
        "PriceFrom": 0,
        "PriceTo": 0,
        "RoundToDecimals": 0,
        "RoundingDirection": 0,
        "PriceEndsFrom": 0,
        "PriceEndsTo": 0,
        "RoundingValue": 0
      }
    ]
  }'

Responses

If the rounding rule was successfully updated

Bodyapplication/json
integer(int32)
Response
application/json
0

List rounding rules

Request

Get a list of all rounding rules

Headers
account-idintegerrequired

User Account ID

application-idintegerrequired

Application ID

curl -i -X GET \
  https://customer-slug.api-se.playground.norce.tech/commerce/management/1.0/api/pricing/roundingrule \
  -H 'account-id: 0' \
  -H 'application-id: 0'

Responses

Returns the list of rounding rules, if any exists

Bodyapplication/jsonArray [
Idinteger(int32)

The rounding rule identifier

TypeIdinteger or null(int32)

Optional price list type identifier

TypeNamestring or null

Optional name of the price list type

CurrencyIdinteger or null(int32)

Optional currency identifier, if the rounding rule is currency specific

CurrencyCodestring or null

Optional currency code, if the rounding rule is currency specific

CurrencyNamestring or null

Optional currency name, if the rounding rule is currency specific

ApplicationIdinteger or null(int32)

Optional application identifier, applies to price lists that are public on a specific application.

ApplicationNamestring or null

Optional application name

FieldIdinteger or null(int32)

Optional field identifier, if the rounding rule is specific to a certain field. Allowed values are: null (not field specific), 1 (Sale Price), 2 (Recommended Price), 3 (Catalog Price)

FieldNamestring or null

Optional field name, if the rounding rule is specific to a certain field.

DefaultNamestring or null[ 0 .. 255 ] characters

The name of the rounding rule for the default language.

DefaultDescriptionstring or null

The description of the rounding rule for the default language.

IsIncludingVatboolean or null

Indicates whether the rounding rule is applied on amounts including VAT or excluding VAT

IsMinimumMarginForcedboolean

Indicates how the rounding rules should adhere to minimum margin settings. If true, minimum margin fallbacks are forced after rounding, which may override rounding results.

TestDataArray of objects or null(RoundingTestPair)

Test data for validating rounding rule calculations, used in administration UI

IsActiveboolean

Indicates whether the rounding rule is active

Changedstring or null

The date and time the rounding rule was last changed

ChangedBystring or null

Fullname or Systemname of the user who last changed the rounding rule

SettingsArray of objects or null(RoundingRuleSettingModel)

The list of rounding rule settings that define specific rounding criteria

RoundingRuleSettingArray of objects or null(IRoundingRuleSetting)
]
Response
application/json
[
  {
    "Id": 0,
    "TypeId": 0,
    "TypeName": "string",
    "CurrencyId": 0,
    "CurrencyCode": "string",
    "CurrencyName": "string",
    "ApplicationId": 0,
    "ApplicationName": "string",
    "FieldId": 0,
    "FieldName": "string",
    "DefaultName": "string",
    "DefaultDescription": "string",
    "IsIncludingVat": true,
    "IsMinimumMarginForced": true,
    "TestData": [ … ],
    "IsActive": true,
    "Changed": "string",
    "ChangedBy": "string",
    "Settings": [ … ],
    "RoundingRuleSetting": [ … ]
  }
]

Add new rounding rule

Request

Add a new rounding rule

Headers
account-idintegerrequired

User Account ID

application-idintegerrequired

Application ID

Bodyapplication/jsonrequired

Rounding rule to add

Idinteger(int32)

The rounding rule identifier

TypeIdinteger or null(int32)

Optional price list type identifier

TypeNamestring or null

Optional name of the price list type

CurrencyIdinteger or null(int32)

Optional currency identifier, if the rounding rule is currency specific

CurrencyCodestring or null

Optional currency code, if the rounding rule is currency specific

CurrencyNamestring or null

Optional currency name, if the rounding rule is currency specific

ApplicationIdinteger or null(int32)

Optional application identifier, applies to price lists that are public on a specific application.

ApplicationNamestring or null

Optional application name

FieldIdinteger or null(int32)

Optional field identifier, if the rounding rule is specific to a certain field. Allowed values are: null (not field specific), 1 (Sale Price), 2 (Recommended Price), 3 (Catalog Price)

FieldNamestring or null

Optional field name, if the rounding rule is specific to a certain field.

DefaultNamestring or null[ 0 .. 255 ] characters

The name of the rounding rule for the default language.

DefaultDescriptionstring or null

The description of the rounding rule for the default language.

IsIncludingVatboolean or null

Indicates whether the rounding rule is applied on amounts including VAT or excluding VAT

IsMinimumMarginForcedboolean

Indicates how the rounding rules should adhere to minimum margin settings. If true, minimum margin fallbacks are forced after rounding, which may override rounding results.

TestDataArray of objects or null(RoundingTestPair)

Test data for validating rounding rule calculations, used in administration UI

IsActiveboolean

Indicates whether the rounding rule is active

Changedstring or null

The date and time the rounding rule was last changed

ChangedBystring or null

Fullname or Systemname of the user who last changed the rounding rule

SettingsArray of objects or null(RoundingRuleSettingModel)

The list of rounding rule settings that define specific rounding criteria

RoundingRuleSettingArray of objects or null(IRoundingRuleSetting)
curl -i -X POST \
  https://customer-slug.api-se.playground.norce.tech/commerce/management/1.0/api/pricing/roundingrule \
  -H 'Content-Type: application/json' \
  -H 'account-id: 0' \
  -H 'application-id: 0' \
  -d '{
    "Id": 0,
    "TypeId": 0,
    "TypeName": "string",
    "CurrencyId": 0,
    "CurrencyCode": "string",
    "CurrencyName": "string",
    "ApplicationId": 0,
    "ApplicationName": "string",
    "FieldId": 0,
    "FieldName": "string",
    "DefaultName": "string",
    "DefaultDescription": "string",
    "IsIncludingVat": true,
    "IsMinimumMarginForced": true,
    "TestData": [
      {
        "Price": 0,
        "Rounded": 0
      }
    ],
    "IsActive": true,
    "Changed": "string",
    "ChangedBy": "string",
    "Settings": [
      {
        "Id": 0,
        "RuleId": 0,
        "PriceFrom": 0,
        "PriceTo": 0,
        "PriceEndsFrom": 0,
        "PriceEndsTo": 0,
        "RoundToDecimals": 0,
        "RoundingDirection": 0,
        "RoundingValue": 0,
        "Changed": "string",
        "ChangedBy": "string"
      }
    ],
    "RoundingRuleSetting": [
      {
        "Id": 0,
        "RuleId": 0,
        "PriceFrom": 0,
        "PriceTo": 0,
        "RoundToDecimals": 0,
        "RoundingDirection": 0,
        "PriceEndsFrom": 0,
        "PriceEndsTo": 0,
        "RoundingValue": 0
      }
    ]
  }'

Responses

If the rounding rule was successfully added

Bodyapplication/json
integer(int32)
Response
application/json
0

Shopping InfoType

Operations

Store Application

Operations

Store PriceList

Operations

Store

Operations

Store Warehouse

Operations

Supplier PriceList

Operations

Supplier PriceListWarehouse

Operations

Supplier

Operations

Supplier Warehouse

Operations

Supplier WarehouseLocation

Operations

Product VariantGroup

Operations

Product WarehouseLocation

Operations

Product Warehouse

Operations