MANAGEMENT API

ClientSalesAreaVatCodeModel

Management API (v1)

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

Download OpenAPI description

openapi.json

openapi.yaml

Servers

Playground

https://{slug}.api-se.playground.norce.tech/commerce/

Stage

https://{slug}.api-se.stage.norce.tech/commerce/

Production

https://{slug}.api-se.norce.tech/commerce/

Settings ApplicationCountry

Manage application countries

Operations

Settings ApplicationCulture

Manage application cultures

Operations

Settings ApplicationCurrency

Operations

Settings ApplicationSalesArea

Operations

Settings Application

Operations

CategoryParametric

Manage parametric categories

Operations

Settings ClientAssortment

Operations

Settings ClientCurrency

Operations

PriceList ClientPriceListType

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 PriceListType

Operations

PriceList Warehouse

Operations

Product FlagGroup

Operations

Product Flag

Operations

Product InfoType

Operations

Product Type

Operations

Promotion

Operations

Product RelationType

Operations

PriceList RoundingRule

Operations

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

Schemas

ClientSalesAreaModel

ClientSalesArea model, represents a sales area associated with the client, indicating whether the client has at least one application with this sales area enabled. Each sales area has a set of VAT codes associated with it, with one VAT code marked as primary for the sales area. This primary VAT code will be used as default VAT code for products unlesss overridden at category or product level.

Idinteger(int32)required

The sales area identifier.

Namestring or null[ 0 .. 255 ] characters

The name of the sales area.

Codestring or null[ 0 .. 50 ] characters

The code of the sales area.

IsPrimarybooleanrequired

Indicates whether this is the primary sales area for the client.

VatCodesArray of objects or null(ClientSalesAreaVatCodeModel)

The collection of VAT codes associated with this sales area for the client.

PrimaryVatCodeIdinteger(int32)required

The identifier of the primary VAT code for this sales area.

Changedstring or null

The date and time when the ClientSalesArea entity was last changed.

ChangedBystring or null

The name of the user who last changed the ClientSalesArea entity.

{
  "Id": 0,
  "Name": "string",
  "Code": "string",
  "IsPrimary": true,
  "VatCodes": [
    { … }
  ],
  "PrimaryVatCodeId": 0,
  "Changed": "string",
  "ChangedBy": "string"
}

ClientSalesAreaVatCodeModel

VAT code model associated with a client sales area.

Idinteger(int32)required

The VAT code identifier.

Namestring or null[ 0 .. 255 ] characters

The name of the VAT code.

Valuenumber(double)required

The VAT rate value as a decimal.

{
  "Id": 0,
  "Name": "string",
  "Value": 0.1
}

CopyToApplicationResult

Result for a single application copy operation

ApplicationIdinteger(int32)

The target application ID

ApplicationNamestring or null

The name of the target application

Successboolean

Whether the copy was successful

NewPromotionIdinteger or null(int32)

The ID of the newly created promotion (if successful)

ErrorMessagestring or null

Error message if the copy failed

{
  "ApplicationId": 0,
  "ApplicationName": "string",
  "Success": true,
  "NewPromotionId": 0,
  "ErrorMessage": "string"
}