Skip to content
STORM API
/
Customer Service
/
/
CompanyPaymentMethod

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

CompanyDiscount

TypeIdinteger(int32)

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

Valuestring

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. MaxLength: 50.

Discountnumber(decimal)

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

PriceListTypeSeedstring

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

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

CompanyPaymentMethod

CompanyCodestring

The external code of the company. MaxLength: 50.

PaymentMethodCodestring

The external code of the payment method. MaxLength: 50.

InvoiceCaptureSettingsCodestring

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

IsActiveboolean

Whether or not the company payment method is active.

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

Contact

Idinteger or null(int32)

The internal Id of the Contact.

Keystring(guid)

The system wide unique Key for the Contact.

Codestring

The external code. Usually the id in the erp system. MaxLength: 50.

ResponsibilityIdinteger(int32)

The ResponsibilityId of the Contact.

Emailstring

The Email of the Contact. MaxLength: 255.

FirstNamestring

The FirstName of the Contact. MaxLength: 50.

LastNamestring

The LastName of the Contact. MaxLength: 50.

Phonestring

The Phone number of the Contact. MaxLength: 50.

CellPhonestring

The CellPhone number of the Contact. MaxLength: 50.

ImagePathstring

MaxLength: 255. Obsolete! - Use ImageKey

ImageKeystring or null(guid)

A unique id for the image at our image server. Url for images are formed like http://[client specific CDN]/{ImageKey}. Preset, height and width can be sent as parameters.

{
  "Id": 0,
  "Key": "string",
  "Code": "string",
  "ResponsibilityId": 0,
  "Email": "string",
  "FirstName": "string",
  "LastName": "string",
  "Phone": "string",
  "CellPhone": "string",
  "ImagePath": "string",
  "ImageKey": "string"
}

Accounts

Operations

Address

Operations

Companies

Operations

Contacts

Operations

Customers

Operations

Flags

Operations

InfoTypes

Operations

PriceLists

Operations