COMMERCE SERVICES
/
Customer Service
/
Schemas
/
CompanyPaymentMethod

Norce Commerce Customer v1.1 service (1.1)

The Customers namespace has Entities and Operations concerned with Customer and Company management.

Download OpenAPI description
openapi-v1.json
openapi-v1.yaml
Languages
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/

Accounts

Operations

Address

Contains endpoints for managing addresses on Customer and Company objects.

Operations

Companies

Contains endpoints for managing Company data and related information.

Operations

Customers

Contains endpoints for managing Customer data and related information.

Operations

Flags

Contains endpoints for viewing Customer and Company flags.

Operations

InfoTypes

Contains endpoints for viewing metadata about Customer and Company extended fields.

Operations

PriceLists

Contains endpoints for managing company connected price lists.

Operations

Schemas

CompanyDiscount

Company discounts are specific discounts that are not based on priceLists and applied on product prices before display. Best price will be taken. Discounts are not stackable.

TypeIdinteger or null(int32)

The TypeId defines the rule for how Value is interpreted. 1 = Category discount, 2 = DiscountCode on product. Cannot be changed.

Valuestring or null

The value to check for on products. If TypeID = 1 then discounts are valid for all products belonging to Category with Category.Code = Value. If TypeId = 2 then the product's discount code is checked. Cannot be changed.

Discountnumber or null(decimal)

The actual discount percentage. Ex: 15.00 equals 15% discount.

PriceListTypeSeedstring or null

An optional comma-separated list of priceList type-ids for which the discount is valid.

{
  "TypeId": 0,
  "Value": "string",
  "Discount": 0,
  "PriceListTypeSeed": "string"
}

CompanyPaymentMethod

Defined payment method for a Company.

CompanyCodestring or null

The external code of the company.

PaymentMethodCodestring or null

The external code of the payment method.

InvoiceCaptureSettingsCodestring or null

The invoice capture settings code (if any is set).

IsActiveboolean or null

Whether or not the company payment method is active.

{
  "CompanyCode": "string",
  "PaymentMethodCode": "string",
  "InvoiceCaptureSettingsCode": "string",
  "IsActive": true
}

CompanyPricelist

Defines a pricelist in this namespace. This is used when setting up Company specific priceLists for resellers. Insert and Update methods are provided. In order to delete a priceList just use DeleteCompanyPricelist.

Idinteger or null(int32)

The internal pricelist id. Set to null when creating a new pricelist.

ParentIdinteger or null(int32)

The parent internal pricelist id. If any.

Namestring or null

The name of the pricelist.

Descriptionstring or null

The description of the pricelist.

Agreementstring or null

The agreement code of the pricelist. Can be an external id of the priceList.

Typeinteger or null(int32)

The type of the pricelist. 0 is default. Other values are application specific.

IsActiveboolean or null

Specifies if the pricelist is active or not. Set this to false before update if you want to delete the pricelist.

PriceRuleobject or null

Defines a price rule for a priceList in this namespace.

PopulationRulesArray of objects or null(PricelistPopulationRule)

A list of population rules for this pricelist.

CurrencyIdinteger or null(int32)

The currencyId for this pricelist.

IsExclusiveboolean or null

Indicates if the pricelist should be used exclusively for this Company, or not. Exclusive pricelists are not used with any standard pricelists and only exclusive pricelists will be in scope if the Company has any.

{
  "Id": 0,
  "ParentId": 0,
  "Name": "string",
  "Description": "string",
  "Agreement": "string",
  "Type": 0,
  "IsActive": true,
  "PriceRule": {
    "RuleId": 0,
    "Value": 0
  },
  "PopulationRules": [
    { … }
  ],
  "CurrencyId": 0,
  "IsExclusive": true
}