Skip to content
STORM API
/
Customer Service
/
/
Login

Documentation CustomerService (1.1)

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

Download OpenAPI description
openapi.json
openapi.yaml
Languages
Servers
https://demo.storm.io/api/1.1/

Schemas

Schemas

Flag

Idinteger(int32)

The internal Id of the Flag.

Namestring

The Name of the Flag. MaxLength: 50.

Groupinteger(int32)

The GroupId of the Flag.

IsSelectedboolean

Indicates if the Flag is selected or not.

{
  "Id": 0,
  "Name": "string",
  "Group": 0,
  "IsSelected": true
}

Login

LoginNamestring

User login name MaxLength: 255.

Passwordstring

User's password MaxLength: 4000.

CultureCodestring

Specifies in which language to display culture specific information. If none is supplied, value is resolved from Application. MaxLength: 16.

IncludeCompaniesstring

Include full company data, if any, with the customer. Otherwise only primary company, if any, is included. Default is true. MaxLength: bool.

{
  "LoginName": "string",
  "Password": "string",
  "CultureCode": "string",
  "IncludeCompanies": "string"
}

Pricelist

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

The name of the pricelist. MaxLength: 50.

Descriptionstring

The description of the pricelist. MaxLength: max.

Agreementstring

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

Typeinteger(int32)

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

IsActiveboolean

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

PriceRuleobject(PricelistPriceRule)(PricelistPriceRule)
PopulationRulesArray of objects(PricelistPopulationRule)(PricelistPopulationRule)

A list of population rules for this pricelist.

CurrencyIdinteger(int32)

The currencyId for this pricelist.

IsExclusiveboolean

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
}

Accounts

Operations

Address

Operations

Companies

Operations

Contacts

Operations

Customers

Operations

Flags

Operations

InfoTypes

Operations

PriceLists

Operations