Classes

The classes in PCL act primarily as information carriers, and should be used both for making calls against the public methods and possibly also for handling data on the website. Most classes have no information set on them at construction, but are populated by using the public methods or by filling in primary data. The max lengths represent the maximum in Harmoney. The actual Harmoney implementation for each company might further restrict this length, e.g. zip codes in Sweden are limited to five numbers but the maximum length in the Harmoney database is 9 characters. The actual limit is therefore 5 characters, and it is usually up the company integrating with Harmoney’s web services to limit the input.

Address

Parameter	Type	Max length	Default value	Comment
Id	string	5 char
FirstName	string	35 char
LastName	string	35 char
Type	AddressType		None	See the Enum for AddressTypes
Street	string	35 char
ZipCode	string	9 char
City	string	35 char
Country	string	2 char	SV	Country is an ISO 3166-1 alpha value.
CareOfAddress	string	35 char
AdditionalName	string	35 char		An addition to the customers name can be registred here
AdditionalAddress	string	35 char		Extra address field for the customer
AdditionalDistrict	string	35 char		Extra address field for the customer
Contacts	Contact			See section Contact

AlternativeClubItem

A carrier for an alternativ club item

Parameter	Type	Max length	Description	Comment
CustomerId	string	9 char	The customer id
Period	string		The current period of the alt. item
List of alt. items			A list of alternative club items	See section AlternativeItem

AlternativeItem

A carrier for an alternativ item

Parameter	Type	Max length	Description	Comment
Id	string	3 char	Row id	Actual length varies for different companies
DistributionId	string	5 char	The id of the distrubution
Selected	boolean		Shows if the item is selected	true = selected, false not selected, if not supplied, then unknown
ItemNumber	string	15 char	Item number	Actual length varies for different companies
Attribute1	string	5 char	Depends on company parameters. Usually color/shade	Actual length varies for different companies
Attribute2	string	5 char	Depends on company parameters. Usually size	Actual length varies for different companies
Attribute3	string	5 char	Depends on company parameters.	Actual length varies for different companies
Attribute4	string	5 char	Depends on company parameters.	Actual length varies for different companies
Attribute5	string	5 char	Depends on company parameters.	Actual length varies for different companies
ItemDescription	string	75 char	The description of the item
Quantity	int?		Quantity	Nullable int
Price	decimal?		The price of the alternativ item	Nullable decimal
ItemType	string	2 char	The code of the item
ItemTypeDescription	string	40 char	The description of the item type

BonusVoucher

Carrier for a bonus voucher (Swedish: ”värdecheck”).

Parameter	Type	Max length	Default value	Comment
Id	string	22 char		Serial number
ArticleNumber	string	15 char		If connected to a specific product id
ArticleDescription	string	20 char
DaysValid	double			Number of days the voucher is valid
UploadedDate	DateTime		DateTime.MinValue	Date when voucher was created
UtilizedDate	DateTime		DateTime.MinValue	Date when voucher was used
Value	double
Response	object			See section Response
ProcessedDate	ProcessedDate		DateTime.MinValue	The premium is processed on this date. Processing can mean that it has been set up as an order, as credit or printed as a voucher.
DueDate			DateTime.MinValue	DueDate (ProcessedDate + DaysValid)

Campaign

Carrier for a campaign in Harmoney (Swedish: ”Huvudaktivitet”).

Parameter	Type	Max length	Default value	Comment
Id	string	7 char
Name	string	100 char
StartDate	DateTime		DateTime.MinValue
EndDate	DateTime		DateTime.MinValue
SubCampaign	List of Subcampaign			See section SubCampaign
objects
Response	object			See section Response

Charge

Used for e.g. order/invoice fees.

Parameter	Type	Max length	Default value	Comment
Description	string	75 char
Item	object			See section Item
VatCode	string	2 char		Id for which type of VAT
VatPercent	decimal			VAT percentage
Amount	decimal

Club

An object which inherits most of its attributes from the ClubProperties object. Is used when you only want to fetch club information.

Parameter	Type/Modifiable	Max length	Default value	Comment
CustomerId	string/No	9	Empty
MemberShipOnHoldFrom	DateTime/No		DateTime.MinValue	If the customer has chosen to pause their membership, this date represents the first day of that pause.
MemberShipOnHoldTo	DateTime/No		DateTime.MaxValue	The customer’s membership will be paused up untill this date.
Period	string/No		Empty	The period Id
PeriodName	string/No		Empty	The name of the period
NoThanks	bool?/No		false	If the customer has declined the current period
Branch	string/No		Empty	What branch the customer is connected to
NegativeOption	bool?/No		false	If true, the customer shall have negative option-deliveries. If false, the customer will not automatically recieve the period’s item.
Interval	double/No		0	If the customer does not want each negative option deliveries, but for example every third period instead. That value is set here and automatically skips the periods by setting NoThanks to true. Only whole numbers.
Media	string/No		Empty	What form the media is in, print, digital etc. Is a code in Harmoney
MediaRecieverId	string/No		Empty	Who is the reciever of the media? Is defined by a code in Harmoney.
ObligationId	string/No		Empty	The obligation Id
ObligationFulfilled	ObligationFulfilled/No		HasNoObligation	Is the obligation fulfilled or not? See section ObligationFulfilled
Closed	bool?/No		false	Is the customer’s membership closed or not?

ClubProperties

Used to get or set information regarding club functionality

Parameter	Type/Modifiable	Max length	Default value	Comment
Period	string/Yes		Empty	The period Id
PeriodName	string/Yes		Empty	The name of the period
NoThanks	bool?/Yes		false	If the customer has declined the current period
Branch	string/Yes		Empty	What branch the customer is connected to
NegativeOption	bool?/Yes		false	If true, the customer shall have negative option-deliveries. If false, the customer will not automatically recieve the period’s item.
Interval	double/Yes		0	If the customer does not want each negative option deliveries, but for example every third period instead. That value is set here and automatically skips the periods by setting NoThanks to true. Only whole numbers.
Media	string/Yes		Empty	What form the media is in, print, digital etc. Is a code in Harmoney
MediaRecieverId	string/Yes		Empty	Who is the reciever of the media? Is defined by a code in Harmoney.
ObligationId	string/No		Empty	The obligation Id
ObligationFulfilled	ObligationFulfilled/No		HasNoObligation	Is the obligation fulfilled or not? See section ObligationFulfilled
Closed	bool?/Yes		false	Is the customer’s membership closed or not?

ConsentValue

Used in the GetConsents-method which is used to display all active consents for a specific sales channel.

Parameter	Type	Default value	Comment
Id	string	Empty	The Id - key.
Title	string	Empty	The title of the consent.
Description	string	Empty	The description of the consent.
DefaultNumberDays	string	Empty	Default number of days when consent is expired.

Contact

Used to save additional contact information on a customer. Exists in the Address-object.

Parameter	Type	Max length	Default value	Comment
Type	string	2	Empty	What type of contact information (a 2 digit code which represents the type).
Text	string	75	Empty	The actual contact information, could be a phone number, mail etc.

CreditCard

Carrier for credit card information. Has to be sent in when order is payed with CreditCard, GenericCreditCard, GenericDirectPayment, GenericInvoice, Paypal

Parameter	Type	Max length	Default value	Comment
IpAddress	string		Empty string	Used for saving the customer’s IP address, e.g. for identifying attemps of fraud. The value is duplicated in the OrderProperties field CallerIpAddress. If CreditCardIpAddress is empty or not equal to OrderProperties.CallerIpAddress the latter will overwrite.
MerchantId	string	20 char		Account id for i.e. identification towards DIBS. Usage depends on implementation.
Name	string	70 char		Name of credit card holder/owner
PanNumber	string	20 char		The credit card number. Is not mandatory. Usage depends on implementation
Type	string	Enum	01	Default value represents VISA. See CreditCardType
ValidFrom	DateTime		DateTime.MinValue
ValidTo	DateTime		DateTime.MinValue	The credit cards valit-to date. Must be filled in.
PromissoryNoteNeeded	bool		false	true or false depending on implementation of Titan as an external partner
ExternalReference	string		Empty string	The external reference for a certain credit card.
DefaultCard	bool?		false	Determines if the registred card is the default or not.
ExternalAccount	string		Empty string	When placing an order with Klarna Advanced, external account is mandatory
AuthorizationDate	DateTime?		null	Date for how long we can authorize a payment
OrderId	string		string.Empty	Only use this when using DibsD2 as payment method. It’s a requriment for performing a capture.
Response	object			See section Response

CreditCheck

Abstract class to be inherited by different types of credit checks

Parameter	Type	Max length	Default value	Comment
Response	object			See section Response

CreditCheckDecidas

Parameter	Type	Max length	Default value	Comment
CreditGranted	Enum		Enums.CreditCheckResult.Failed
SSN	string	13 char		Must follow standard format depending on country.
CreditLimit	decimal
CreditScore	decimal
IdCheckExecuted	boolean
PreviousCustomerNo	string	9 char
DateLateRequest	DateTime		DateTime.MinValue
Response	object			See section Response

Customer

Carrier for customer information.

Parameter	Type	Max length	Default value	Comment
CustomerId	string	9 char		Customer ID number.
FirstName	string	71 char
LastName	string	71 char
Address	List of address objects			See section Address
PhoneNumberList	List of Phonenumber objects			See section PhoneNumber
Email	string	75 char
Gender	Enum		Gender.Unknown	Valid values are Unknown, Male, Female, Company
SSN	string	13 char		Must follow standard format depending on country
ControlStatus	boolean			Used to indicate if a customer has ended up on the Control Page in Harmoney during customer validating or saving
Properties	CustomerProperties			See section CustomerPropeties
CreditCheck	object			See section CreditCard
Reponse	object			See section Response
ClubProperties	ClubProperties			See section ClubProperties
CustomerConsent	CustomerConsent			See section CustomerConsent
SalesChannelInfoList	List of SalesChannelInfo			See section SalesChannelInfo
MiscInfoList	List of MiscInfo		Empty list	This will always be empty in all GetCustomer methods. GetCustomerByMiscInfo method returns customer object if Enums.MiscInfoType.Voyado and Voyado id is provided See section MiscInfo
AdditionalCustomerId	string	75 char		Additional customer id can be used as an alternate reference for finding a customer object. For example a “guid reference” used in correspondence with the customer.

CustomerCrmInfo

Carrier for customer crm

Parameter	Type	Max length	Comment
CustomerId	string	9 char	Customer Id in Harmoney
CrmId	string	75 char	Crm Id on customer
Response	object		See section Response

CustomerConsent

Used to display active consents on a customer but also in the SaveCustomer, ValidateOrder and SaveOrder methods to update consents on a customer.

Parameter	Type/Modifiable	Max length	Default value	Comment
Id	string/No	2 char	Empty	The Id - key.
Title	string/No		Empty	The title of the consent.
Active	bool/Yes		false	True = Agree with consent, False = Don’t agree with consent.
CreateDate	DateTime/No		DateTime.Now	Date when consent was created.
Lastupdate	DateTime/No		DateTime.Now	Last date when the consent was updated.
ConsentDate	DateTime/Yes		DateTime.Now	Used if you want to override when consent was made (CreateDate). If null, DateTime.Now will be saved in CreateDate.
ExpiredDate	DateTime/Yes		DateTime.Now	Date when consent is expired, if null then default days on consent will be used.
OrderMethod	Enum/Yes		OrderMethod.Internet	The chosen order method.
OrderMethodInfo	string/Yes	254 char	Empty	Extra info, for example, ip-address.

CustomerNewStart

This class is used to reactivate an old customer/member. All stats and activities will be reset. SubCamapign must be set in other to use this class. This can be used in the ValidateCustomer, SaveCustomer, ValidateOrder and SaveOrder methods.

Parameter	Type	Default value	Comment
EnableNewStart	bool/Yes	false	Bool set to true if a newstart should be used.
SendWelcomeMessage	bool/Yes	false	Set to true if Harmoney should send an welcome by e-mail/letter

CustomerObligation

Used to display information regarding a customer’s obligation.

Parameter	Type/Modifiable	Default value	Comment
ObligationId	string/No	Empty	The Id for this obligation.
ObligationFulfilled	ObligationFulfilled/No	HasNoObligation	Indicates if the customer has fulfilled the obligation. See section See section ObligationFulfilled
ObligationCompletionDate	DateTime/No	DateTime.Max	The date of which the obligation was fulfilled.
PaidAmount	double/No	0	The amount the customer has paid which have gone to the fulfilling this obligation.
NumberOfPeriods	double/No	0	The number of periods the customer has had this obligation active.
ObligatedNumberOfPeriods	double/No	0	The obligated number of periods the customer has to be active for this obligation to be fulfilled.
NumberOfDeliveredArticles	double/No	0	The delivered amount of articles the customer has which will count towards the completion of this obligation.
NumberOfPayedArticles	double/No	0	The number of articles the customer has payed for which counts towards the completion of this obligation.
ObligatedNumberOfArticles	double/No	0	The number of articles the customer has to buy to fulfill this obligation.
BenefitValue	double/No	0	The amount the customer gets billed in the form of a compensation invoice if the obligation is not fulfilled.
MessageHasBeenSent	bool/No	false	Indicates if a message has been sent to the customer to remind them of this obligation.
CompensationInvoiceSent	bool/No	false	Indicates if a compensation invoice has been sent because the customer failed to fulfill the obligation in time.

CustomerProperties

Carrier for customer information.

Parameter	Type	Max length	Default value	Comment
ProtectedPhoneNumber	boolean		False	Marks if phone number should not be shown publicly. Number is still shown in Harmoney.
ProtectedAddress	boolean		False	Marks if address should be shown publicly. Address is still shown in Harmoney
AcceptEmailOffer	Enum Bool		True	Marks if customer accepts to recieve email offers and newsletters
AcceptSmsOffer	Enum Bool		True	Marks if customer accepts text message offers
AcceptDirectMail	Enum Bool		True	Marks if customer accepts offers by direct mail
SendSmsMessage	Enum Bool		False	Marks if a text message(SMS) should be sent.
SendEmailMessage	Enum Bool		True	Marks if a text message(Email) should be sent.
AcceptTelemarketingOffer	Enum Bool		True	Marks if customer accepts to recieve offers from telemarketing
AcceptAddressOffer	Enum Bool		True	Marks if customer accepts to recieve offer by letter
AcceptOfferByPhone	Enum Bool		True	Marks if customer accepts to recieve offers by phone
AcceptEmailSales	Enum Bool		True	Marks if customer accepts to recieve email offers
MemberOfLoyaltyProgram	Enum Bool		Unknown	Marks if customer is part of a loyalty program. See section Bool
MembershipLevel	string	2 char		Is used to either display- or update the customer’s membership level.
PendingMembershipLevel	string	2 char		This value displays the pending membership of a customer’s upcoming membership level. This value cannot be modified, it is only used for displaying purposes.
LoyaltyExpireDate	DateTime			If a customer has ended their loyalty membership this date represents the date of when their membership expires.
LoyaltyNextInvoiceDate	DateTime			If a customer has an active loyalty membership this date represents the
LoyaltySkipPeriod	Enum Bool			Marks if customer will skip next period invoice. date of when the next invoice.
RequestCatalog	bool		False	If customer wants a catalog from a response activity.
EnrolledByCustomerId	string	9 char		Customer id of the person who enrolled the current customer.
LoyaltyPaymentMethod	Enum PaymentMethod		Default	The chosen method of payment for the loyalty program.
SubCampaignId	string	7 char		Subcampaign connected to the specific customer.
PayingCustomer	string	9 char		Customer Id to the customer account that pays for the order
BlockingId	string	2 char		Code value for blocking the customer e.g. due to unpaid bills.
Text	string	4000 char		Text message to send the customer services. Setting a text message will always make the order an control order and it will be shown on the control page in Harmoney.
CreditCheckResult	Enum CreditCheckResult	None		Result from credit check. Default value is None if no credit check has been conducted. See section CreditCheck
CreditCheckTemplate	string	20 char
CreditCheckStatus	Enum CreditCheckStatus			Set by Harmoney. Shows if the customer already has performed a credit check and latest status. See section CreditCheck
CategoryId	string	02 char	01	Customer category
PreferredPaymentMethod	Enum PaymentMethod		Default	Is usually used to indicate which payment method the customer used most recently
PreferredDeliveryMethod	Enum DeliveryMethod			Is usually used to indicate which delivery method the customer used most recently. See section DeliveryMethod
PreferredExternalPartService	string	6 char		Is usually used to indicate which delivery method service the customer used most recently
PreferredLanguage	Enum Language			Is usually used to indicate which language the customer used most recently
PaymentProperties	PaymentProperties			See section PaymentProperties
ElectronicInvoice	ElectronicInvoice			See section ElectronicInvoice
CustomerNewStart	CustomerNewStart			See section CustomerNewStart
Balance	decimal			Credit balance. Used for statistics. Set by Harmoney
CreditLimit	decimal			Allowed credit limit. Used for statistics. Set by Harmoney
PayedAmount	decimal			Total payed amount. Used for statistics. Set by Harmoney.
DeliveredAmount	decimal			Total delivered amount. Used for statistics. Set by Harmoney.
NumberOfOrders	decimal			Number of orders. Used for statistics. Set by Harmoney.
NumberOfDeliveries	decimal			Number of deliveries. Used for statistics. Set by Harmoney
NumberOfPayedOrders	decimal			Number of payed orders. Used for statistics. Set by Harmoney.
NumberOfUnPayedOrders	decimal			Number of unpayed orders. Used for statistics. Set by Harmoney.
NumberOfUnPayedProducts	decimal			Number of unpayed products. Used for statistics. Set by Harmoney
NumberOfPayedProducts	decimal			Number of payed products. Used for statistics. Set by Harmoney.
NumberOfPurchasedProducts	decimal			Number of purchased products. Used for statistics. Set by Harmoney
NumberOfReturnedProducts	decimal			Number of returned products. Used for statistics. Set by Harmoney
NumberOfNonPickedUpDeliveries	decimal			Number of not picked up deliveries. Used for statistics. Set by Harmoney.
RegistrationDate	DateTime		DateTime.MinValue	Date when customer was registered. Used for statistics. Set by Harmoney.
FirstOrderDate	DateTime		DateTime.MinValue	Date of first placed order. Used for statistics. Set by Harmoney.
MostRecentOrderDate	DateTime		DateTime.MinValue	Date of most recently placed order. Used for statistics. Set by Harmoney.
EarliestDeactivationDate	DateTime		DateTime.MinValue	Date for when a customer should be deactivated due to inactivity. If property is not relevant set to DateTime.MinValue
CustomerSegment	string		string.Empty	A value that represents which customer segment the customer belongs to. An example value could be 00-Normal, where 00 is the 2 digit code used to identify the segment in Harmoney. The rest could be visible for the customer if the web wants to display what type of segment the customer belongs to.
RegistrationDateNow	DateTime		DateTime.MinValue	When the customer last was registrated, i.e re-activation
CollectionId	string	2 char		Code value for debt collection.
BindingDate	DateTime		DateTime.MinValue	If the membership level in the loyalty program contains a binding period, the customer’s binding date is returned.
LoyaltyGiftCard	string	10 char		Is used for setting a gift voucher (voucherId) as payment of loyalty program

Note: Method is obsolete (2018-05-25) CustomerUser

Carrier for customer user

Parameter	Type	Max length	Comment
CustomerId	string	9 char
UserId	string	75 char	Length is individual to each Pulsen client. Usually only 4 characters long
UserPassword	string	20 char
Response	object		See section Response

Delivery

Carrier for delivery

Parameter	Type	Max length	Comment
DateOfArrival	string	10 char
Quantity	string	12 char	Digits only

DeliveryDate

A special carrier class to handle delivery dates. Delivery dates can be in three separate formats; year and week, date or custom text, which are set by parameters in Harmoney. Depending on the parameter only certain fields are filled. Contact your sales contact for more information.

Parameter	Type	Max length	Description	Comment
Type	Enum		Determines which fields will have a value	Valid values: YearWeek - only year and week will be filled ShortDate - only date will be filled Text - only text will be filled
Year	integer		The year of delivery	Used with week
Week	integer		The week of delivery	Used with year
Date	DateTime		The date in the YYYY-MM-DD format
Text	string	40 char	A custom delivery date string e.g. “Immediate”	Format and language is determined by parameters in Harmoney

Discount

The Discount object can hold both a discount (lowering the price of an order) and a fee (raising the price of an order). Type can be used to determine if the object is a discount or a fee. Amount is positive for a fee and negative for a discount. Description describes the discount/fee and why it is added to an order. When adding a Discount to an Order, only Item.Id and Amount need to be filled in.

Parameter	Type	Max length	Default value	Comment
Item	Object	15 char		Only Item.Id is set max length is 15 char See section Item
Amount	decimal			Fees have a positive amount. Disounts have a negative amount.
Description	string			Describes what kind of discount or fee. Language dependent.
Type	Enum DiscountType		DiscountType.Fee	Valid values: Fee, Discount

ElectronicInvoice

The ElectronicInvoice class can be used to save information about a customer who uses electronic invoices to pay for orders. This can be used in the SaveOrder, ValidateOrder and SaveCustomer methods.

Parameter	Type	Max length	Default value	Comment
ElectronicInvoiceId	string	30	string.Empty	The customer’s ID for the electronic invoice. This has to be sent in to make changes regarding electronic invoice.
Active	bool		true	Determines if the customer is using electronic invoice. If this is false it’s still possible to save the invoice information. It just won’t be used. Won’t matter unless an ElectronicInvoiceId is sent as well.
Type	Enum ElectronicInvoice		ElectronicInvoice.None	Decides what type of electronic invoice to be used.
Bank	string	2	string.Empty	Decides which bank is used with this electronic invoice. To get the available values for this field, use the GetElectronicInvoiceBanks method in the NameValueService.
ExternelReference	string	75	null	The external reference for the customer’s electronic invoice.

ExternalPickUpLocation

Property	Type	Max length	Description	Comment
Id	string	10 char	Pick up location id
Name	string	35 char	Name of person receiving
Street	string		Street address
ZipCode	string	9 char	Zip code/postal code
City	string	35 char	City
Country	string	2 char	Country	Country is an ISO 3166-1 alpha-2 value.
DeliveryMethod	Enum		Delivery method id	See the Enum for DeliveryMethod.
DeliveryMethodName	string		Delivery method
CoupledZipCodes	List of strings
CityAdditions	string
CityPart	string
TelNo	string
FaxNo	string
ContactPerson	string
OpeningHoursText	string
Directions	string
ReplacedId	string
LengthOfJourney	string
SplitCenter	string
HouseNoMatchId	string
StreetMatchId	string
ActiveDate	string
Hub	string
FirstDeliveryDate	DateTime
LastDeliveryDate	DateTime
InactiveDateForm	DateTime
InactiveDateTo	DateTime

GiftVoucher

Parameter	Type	Max length	Default value	Comment
Id	string	20 char
Amount	decimal
ValidUntil	DateTime		DateTume.MinValue
Response	object			See section Response

HarmoneyError

Carrier for error messages from Harmoney

Parameter	Type	Max length	Description
IsOk	boolean
Message	string	200 char	Error/warning/info message
Company	string	2 char
Type	string	2 char
Procedure	string	40 char	Which procedure returned the message
Id	string	6 char	Identifies the message for each procedure
Language	string	2 char	The language of the error message

InvoiceToChange

This object is used to update the paymentmethod on an invoice.

Parameter	Type	Description	Comment
InvoiceNumber	string	The invoice number
PaymentMethod	Enum	Payment method id	See the Enum for PaymentMethods.
PaymentProperties	PaymentProperties		See section PaymentProperties

Item

Carrier for an item, in Harmoney called a Variant

Parameter	Type	Max length	Description	Comment
Id	string	17 char	Article number/id	Actual length varies for different companies
Attribute1	string	5 char	Depends on company parameters. Usually color/shade	Actual length varies for different companies
Attribute1Description	string	40 char
Attribute2	string	5 char	Depends on company parameters. Usually size	Actual length varies for different companies
Attribute2Description	string	40 char
Attribute3	string	5 char	Depends on company parameters.	Actual length varies for different companies
Attribute3Description	string	40 char
Attribute4	string	5 char	Depends on company parameters.	Actual length varies for different companies
Attribute4Description	string	40 char
Attribute5	string	5 char	Depends on company parameters.	Actual length varies for different companies
Attribute5Description	string	40 char
Showable	boolean		Determines if article is showable on the internet. Set by parameter on the article page in Harmoney	Readonly
Orderable	boolean		Determines if article is showable on the internet. Set by parameter on the article page in Harmoney	Readonly
Status	string	2 char	Article status
ItemPriceList			Contains all ItemPrice zero or more	See section ItemPrice
Response	object			See section Response

ItemPrice

Parameter	Type	Max length	Default value	Comment
PriceGroup	string	2 char
Campaign	object			See section SubCampaign
Price	decimal
PriceDescription	string
Response	object			See section Response

Label

Label object contains information about labelcode and labeltype

Parameter	Type	Default value	Comment
LabelCode	string	01	Code for the label
LabelType	string	02	Type of the label

Ledger

The Ledger object contains information about a customer’s ledger.

Parameter	Type	Default value	Comment
InvoiceNr	string	Empty string	The invoice number.
Invoice date	DateTime	DateTime.Now	The date of the invoice.
DueDate	DateTime	DateTime.Now	The due date of the invoice.
Balance	double	0.00	The Balance of the invoice.
CustomerId	string	Empty string	Represents the customer the invoice belongs to.
Name	string	Empty string	The name of the customer.
StreetAddress	string	Empty string	The customer’s address.
MailingAddres	string	Empty string	the customer’s ZIP code.
LedgerDetails	object		See section LedgerDetails
TransactionDate	DateTime	DateTime.Now	The date of the transaction.

LedgerDetails

The LedgerDetails object contains further information about a certain ledger.

Parameter	Type	Default value	Comment
PostingDate	DateTime	DateTime.Now	The date of posting.
VerificationNr	double	0	The verification number.
Id	double	0	The serial number.
TransactionDate	DateTime	DateTime.Now	The date of the transaction.
LedgerCode	string	Empty string	The ledger code.
LedgerName	string	Empty string	The name of the ledger.
Amount	double	0	The amount of the transaction.
Reference	string	Empty string	Reference number.
PaymentReceived	DateTime	DateTime.Now	The date the payment was received.

ListWrapper

The ListWrapper class is a generic list class used mainly for returning objects from the WsPCL service. The reason is to always include a Response object for meta data about the call.

Property	Type	Comment
List	List of objects	Type is set at initialization of ListWrapper class.
Response	Response object	See section Response

NameValue

The class used in the NameValueService to display codes and their corresponding name from Harmoney

Property	Type/Modifiable	Comment
Id	string/No	The Id of the Harmoney code
Name	string/No	The name of the Harmoney code

Obligation

Represents the class of the Obligation

Property	Type	Max length	Description	Comment
ObligationId	string	5 char	Id of the obligation
RequiredArticlesToBuy	int		Required articles to buy (Full price articles only)
RequiredObligationPeriod	int		Required obligation period (in months)

Order

Parameter name	Type	Max length	Example value	Description	Relevance
Id	string	10 char	1241241223	Order number/id	Does not have to be sent in. Filled in by Harmoney. If the setting: OrdNrExt is active in Harmoney, then you can decide your own orderId.
CustomerId	string	9 char	110588357	Customer id. Must only be filled in if submitting order on existing customer and not sending customer information on call
PaymentMethod	Enum			Payment method id	See section PaymentMethod
PickUpLocation	PickUpLocation			The chosen delivery method for the order.	See section PickUpLocation
ExternalPartner	Enum			External partner id is nillable	If client is using Titan as external partner and a promissory note is needed
RowList				Contains all OrderRow objects, one or more	See section OrderRow
CommodityValue	decimal		132.23	Total value of the order items without fees, VAT etc.	Does not have to be sent in. Filled in by Harmoney.
Fee	decimal		132.23	Expeditionary/handling fee	Does not have to be sent in. Filled in by Harmoney.
Cod	decimal		132.23	Cash-On-Delivery fee. Only relevant when using COD as payment method.	Does not have to be sent in. Filled in by Harmoney.
Vat	decimal		132.23	Taxes and VAT for whole order	Does not have to be sent in. Filled in by Harmoney.
ShippingFee	decimal		132.23	Shipping fee	Does not have to be sent in. Filled in by Harmoney.
OtherFee	decimal		132.23	Other fees	Does not have to be sent in. Filled in by Harmoney.
Discount	decimal		132.23	Discount total	Does not have to be sent in. Filled in by Harmoney.
DeliveryValue	decimal		132.23	Value of whole delivery	Does not have to be sent in. Filled in by Harmoney.
TotalValue	decimal		132.23	Order total	Does not have to be sent in. Filled in by Harmoney.
DeliveryDate	Datetime		2018-08-01	Wished delivery date of the whole order	Order is held up until this date. Filled in by client
ReferenceNumber	string	4000 char	asidnl123	Used for i.e. credit card reference numbers when using credit card as payment method
MerchantId	string	20 char	cpulsen	Used for credit card authorizations. E.g. when using DIBS credit card payments.
AuthorizedAmount	decimal		132.23	Used for credit card authorizations	Has to be sent in when order is payed with CreditCard, DirectPayment, GenericCreditCard, GenericDirectPayment, GenericInvoice, Paypal
AmountToAuthorize	decimal		132.23	Used for credit card authorizations.	Not in use
CreditCard	object			Credit card, only used when credit card is selected as payment method	See section CreditCard
VoucherList				Contains all voucher objects, >= 0	See section Voucher
DiscountList				Contains all discounts >= 0	See section Discount
Text	string	4000 char		Order text. Used i.e. for adding custom message to customer service about the order	Setting a text on order will always make sure it gets stuck on the Control page in Harmoney. This is so customer services can handle the order manually.
OrderTexts	List<OrderText>			Can be used i.e. for adding custom messages to customer service about the order. It will soon replace the field name “Text”.	Setting a text on order will always make sure it gets stuck on the Control page in Harmoney. This is so customer services can handle the order manually. See section OrderText
InternetMessage	string			Internet message	Does not have to be sent in. Filled in by Harmoney
TemporaryDeliveryAddress	object			Temporary delivery address See section Address	Must be filled in if customerId is not.
Label	object			Label on an order	See section Label
DiscountCodes	List<string>			Used to send in simple discount codes.	See https://api.pulsen.se/harmoney-api/index.html for validation of a discount code. Contact Pulsen for access and how to use this service.
AddSaleTax	boolean		false	Setting it to true results in calculation of sale tax on prices and fees.
ControlStatus	boolean		True	Used to indicate if the order will get stuck on the Control page, for instance when calling SaveOrder	Does not have to be sent in. Filled in by Harmoney. See section Control status
Properties	object			Order properties	See section Order properties
UsePoints	int		10	Used to redeem reward points	Does not have to be sent in.
PointsEarned	int		10	Used to see how many points an order is worth	Only returned if Properties.IncludeRewardPointsEarned is set.
Response	object				See section Response

OriginalOrder

Parameter name	Type	Max length	Example value	Description	Relevance
Id	string	10 char	1241241223	Order number/id. Must only be filled in
OrderDate	Datetime		2020-01-19	Date when order was placed
CustomerId	string	9 char	110588357	Customer id.
FirstName	string	35 char
LastName	string	35 char
Street	string	35 char
ZipCode	string	9 char
City	string	35 char
CustomerBalance	decimal			Customer’s total balance in this sales channel
InvoiceBalance	decimal			Customer’s total invoices balance
OrderProcessType	string	40 char		Name on order process type
OrderMethod	string	40 char		Name on order method
Properties	object			Order properties	See section Order properties
RowList				Contains all original orderRow objects,	See section OriginalOrderRow one or more
Response	object				See section Response

Control status

When a validation or saving an order is made there is a chance that the order will end up on the control page in Harmoney, there are some different reasons why that may happen. In these cases, you will, in the response object be able to see the explanation to why the order has been stopped. You will also get the Id and the type. The information will be shown as a Harmoney error e.g.

<HarmoneyError>
  <Name>ControlStatus</Name>
  <Id>90</Id>
  <Language>EN</Language>
  <Type> OrderInControl</Type>
  <Message>The order is stopped and needs to be processed by customer support</Message>
  <IsOk>true</IsOk>
</HarmoneyError>

TemporaryDeliveryAddress

If Order.CustomerId is not filled in it is mandatory to use the Order.TemporaryDeliveryAddress to give delivery address information. If Order.CustomerId is filled in or if a Customer is included in a call to Validateorder/SaveOrder then Order.TemporaryDeliveryAddress can be omitted entirely

Order properties

Carrier for order properties

Property	Type	Max length	Description	Relevance
CallerIpAddress	string		Used for saving the customer’s IP address e.g. for identifying attemps of fraud. The IP address will be shown in Harmoney in connection with the order	Default value is empty. The value os duplicated in the CreditCard.IpAddress field. If the CreditCard.IpAddress is empty or not equal to OrderProperties.CallerIpAddres, the latter will overwrite.
ConductCreditCheck	boolean		Indicates if there is a need for conducting a credit check on the order’s customer	Default value False
ConductRatchetTrack	boolean		Make no block checks on this order.	Default value false.
ConductRatchetCreditTrack	boolean		Do not make a credit check.	Default value false. Introduction orders are marked with no credit check.
CreateNewOrder	boolean		Set to true if you want to create a new order instead of complementing an existing one.	Default value false.
CreditCheckType	Enum		Shows which type of creditcheck is selected	Default value Enums.CreditCheckType.None
CustomerReference	string	4000 char	Customer reference. Can be a text or a number.	This field represents OrdTextTyp 06 in Harmoney.
ExternalReference	string	4000 char	External reference. Can be a text or a number referencing i.e. an order number in another system
GoodsLabeling	string	4000 char	Goodslabeling reference. Can be a text or number.	This field represents “Godsmärkning” OrdTextTyp 05 in Harmoney.
IncludeOrderRowDiscounts			Determines if OrderRowDiscounts(s) should be included in the response	Default value is False. If False, the OrderRow.OrderRowDiscounts list will be empty
Method	Enum		Order method. When sending orders throug hWsPCL method should usually be OrderMethod.Internet.	Default valude is internet. See section OrderMethod
MethodCode	string	2 char	Order method. Same as above but as a string instead.	See section OrderMethod
Pricing	Enum		Gets/sets who should set the prices. Either Harmoney sets the prices or the prices are sent in with the order. The default value is Pricing.PriceAndFeeSetByHarmoney	Valid values: PriceAndFeeSetByHarmoney, PriceAndFeeSetByClient, PriceSetByClientFeesSetByHarmoney,
ProcessType	Enum		Order process type	See section ProcessType
Status	Enum		Order status, describes where in the order process the order is at the moment.	Readonly field. See section OrderState
StatusDescription	string	40 char	Text description of the order	Read only, Filled in by Harmoney.
Type	Enum		status Order type. Default value is OrderType.Normal	Valid values: Default, Normal, NoCharge, NoFees, NoDeliveryFees, UnKnown, Intro
TypeCode	string		Default value is string.Empty. This field will be chosen instead of “Type” if it contains a value	Valid values: Any of the order type codes that are in Harmoney. These codes can be accessed with the NameValueService.asmx using the GetOrderTypeCodes-method.
IncludeRewardPointsEarned	bool		Determines if PointsEarned should be included in the response	Default value is False. If False, the Order.PointsEarned will be empty

OrderRow

Property	Type	Max length	Description	Comment
Id	string	3 char	Order row id
Item	object			See section Item
Quantity	integer		Quantity
Pieces	decimal		Used for custom lengths together with quantity. E.g. 4 lengths(quantity) of 1.5 m string(pieces)
Pricegroup	string	2 char	Used for distinguish between different prices.
Price	decimal		Order row price.
OrdinaryPrice	decimal		Order row ordinary price	OrdinaryPrice is set to an order when its created. Usually taken from activity GRUND. Order properties
Discount	decimal		Discount value
DiscountDescription	string		A description on what type of discount or pricing this article is based on.
Sum	decimal		Order row sum
FullPrice	bool		Indicates if the article in this row is marked with Full Price
SubCampaignId	string	7 char	Subcampaign id	Used for setting a discount or specific price group on an order row.
DeliveryStatus	Enum		Delivery status
DeliveryDate	object		The delivery date. See section DeliveryDate	Read only.
Pending	boolean		Order row is pending processing	This occurs if i.e. the stock status for the article is to low and waiting for delivery warehouse
BonusOrder	boolean		Bonus order row	This occurs when an extra row is added to an order e.g. a catalog is provided free of charge
PartOfVirtualProduct	boolean		Order row/article is part of a package or virtual product
Name	string		Order row name or description.
ExtendedName	string		Extended order row name	Långbenämning in Harmoney
ReturnedQuantity	decimal		Number of articles that has been returned
ReturnCode	string	3 char	The return code as of why the item is returned	Available codes are found in Harmoney
VatPercentage	decimal		VAT percentage	Decimal value, but represents percentage, not real value
VatCode	string	2 char	VAT code id
Vat	decimal		Vat amount	Decimal value, represents the vat amount for the orderrow
OrderId	string	10 char	The order id that the order row is a part of.
TrackingId	string	15 char	Tracking id
OrderRowDiscounts		OrderRowDiscount, zero or more	Discount description for the order row. The description describes what discount affects the order row’s price, and by how much.	See section OrderRowDiscount
OrderRowTexts	object		Contains texts on an orderrow	See section OrderRowTexts
PremiumType	Enum		Premiumtype is used for Introorder	See section PremiumType
ExtendedName	string		Extended name of the product
PriceText	string	char 2	The price text code/id	Available codes are found in Harmoney
PriceTextDescription	string	40 char	The description of the price text
Response	object			See section Response

OriginalOrderRow

Property	Type	Max length	Description	Comment
Id	string	3 char	Originalorder row id
Item	object			See section Item
Name	string	75 char	Originalorder row name or description.
Quantity	decimal		Ordered quantity
Sum	decimal		Total amount
InvoiceNumber	integer		Invoice number
InvoiceDate	DateTime		Invoice date
TrackingId	string	15 char	Tracking id
Balance	decimal		Total invoice balance
Status	enum		Delivery status	See the Enum.DeliveryState
StatusDescription	string	40 char	Description of delivery status
ReminderNumber	string	2 char	Last reminders number
ReminderDate	DateTime		Last reminders date
ReturnCode	string	3 char	The return code as of why the item is returned	Available codes are found in Harmoney
ReturnCodeDescription	string	char 40	Description of return code
VatPercent	decimal		VAT percentage	Decimal value, but represents percentage, not real value
Response	object			See section Response

OrderRowDiscount

The OrderRowDiscount gives information about which discounts a customer receives on an order. Certain discounts are added automatically to the order, and the OrderRowDiscount class is meant to describe the reason behind adding the discount to the order.

Property	Type	Max length	Description	Comment
Id	string		Discount id
Description	string		Discount description
Type	string		Discount type code
Category	decimal		Discount condition group (Swedish: villkorsgrupp)
Level	decimal		Discount level
Amount	decimal		Discount amount	Value depends on currency of the sales channel

OrderRowTexts

Wiht the OrderRowTexts you can send in texts on an orderrow.

Property	Type	Max length	Description	Comment
Type	string		Type of text	Ex: 01=written on inv.
Text	string		Order text. Used i.e. for adding custom message to an orderrow.

PaymentMethod

Property	Type	Max length	Description	Comment
Id	string	2 char	Payment method id
Name	Enum		Payment method name	See section PaymentMethod
Selectable	boolean		Indicates if payment method is available for selecting	Payment methods are individual to each of Pulsen’s clients Please contact your sales contact for more information
ConductCreditCheck	boolean		Indicates if the payment method requires credit checks to be conducted.

PaymentProperties

Parameter	Type	Max length	Comment
ReferenceNumber	string	4000 char	Used for i.e. credit card reference numbers when using credit card as payment method
MerchantId	string	20 char	Used for credit card authorizations. E.g. when using DIBS credit card payments.
AuthorizedAmount	decimal		Used for credit card authorization
AmountToAuthorize	decimal		Used for credit card authorization
CapturedAmount	decimal		Amount that has been captured
PaymentMethod	Enum		See section PaymentMethod
ExternalPartners	Enum		If client is using Titan as external partner and a promissory note is needed
CreditCard	Object		See section CreditCard

PeriodProperties

Used with club functionality for getting information about future- and past periods.

Property	Type/Modifiable	Description	Comment
Period	string/No	The period Id
PeriodName	string/No	The name of the period
NoReason	string/No	The code for the NoThanks reason
NoThanksText	string/No	The reason for NoThanks in plain text
NoThanksDate	DateTime?/No	The date the customer chose to decline the current period
Activity	string/No	The activity the period is related to
ArticleId	string/No	The article Id for the corresponding period
ArticleName	string/No	The article name for corresponding period
Media	string/No	The paper media, print, digital etc.
LastReplyDate	DateTime?/No	The last date for the customer to decline a period
LastReplyDateInt	DateTime?/No	The last date for the customer to decline a period through the web
ExecuteDate	DateTime?/No	The exectue date

PhoneNumber

Phone numbers have a private property “Protected” that determines if the phone number should not be shown publicly.

Property	Type	Max length	Description	Comment
Number	string	75char	The phone number
Type	Enum		The type	Valid values: Home, Work, Mobile

PickUpLocation

Property	Type	Max length	Description	Comment
Id	string	10 char	Pick up location id
Name	string	35 char	Name of person receiving
Street	string		Street address
ZipCode	string	9 char	Zip code/postal code
City	string	35 char	City
Country	string	2 char	Country	Country is an ISO 3166-1 alpha-2 value.
DeliveryMethod	string	2 char	Delivery method id
DeliveryMethodName	string	25 char	Delivery method name
FreightInformation	JSON		Information needed for TMS delivery	This information is unique for each TMS provider
Service	List of objects		Contains all PickUpLocationService objects, zero or more	See section PickUpLocationService
ExternalPart	bool		If returned true, the ExternalPickUpLocation- object has to be included when doing a SaveOrder using this particular PickUpLocation	See section ExternalPickUpLocation
Response	object			See section Response

PickUpLocationService

Represents the service of the DeliveryMethod

Property	Type	Max length	Description	Comment
Id	string	75 char	The Id of the service
Name	string		The name of the service

Premium

Represents the class of Premium

Property	Type	Max length	Description	Comment
Type	Enum		Type of premium	See section PremiumType
PremiumTypeCode	string	2 char	Which type of premium it is	Valid codes 01=Fast, 02=Valbar 03=Valbar maxantal
Quantity	int		PremiumTypeCode 02 quantity
Total days	int		Total days	Only used for PremiumType Promptness
ItemClass	string	2 char	PremiumTypeCode 02,03 option to select articles from this article class
ItemGroup	string	2 char	PremiumTypeCode 02,03 option to select articles from this article group
ItemCode	string	2 char	PremiumTypeCode 02,03 option to select articles from this article code
ArticleList	List of articles		List of selectable articles when PremiumTypeCode 02,03 is used	See section PremiumArticle

PremiumArticle

Represents the class of PremiumArticle

Property	Type	Max length	Description	Comment
ItemId	string	15 char	Article number
Attribute 1	string	5 char	Attribute 1 of the article
Attribute 2	string	5 char	Attribute 2 of the article
ItemDescription	string	20 char	Name of the article
Quantity	int		Quantity of the article(sku)
Price	decimal		Specified price for the article
Full price	bool		Is the price a full price
Net Price	bool		Is the price is a net price
TimeOfDeliveryCode	string	2 char	Set how the premier should be delivered
TimeOfDeliveryValue	string		Value of the TimeDelivery

PremiumOffer

Represents the class of the PremiumOffer

Property	Type	Max length	Description	Comment
MainCampaign	string	7 char	The Id of the main campaign	GRUND
MainCampaignDescription	string		The name of the main campaign
PremiumList	List of Premium		Gets a list of each premium type available.	See section Premium
ObligationId	string	5 char	The Id of an connected obligation
ObligationValue	int		Obligation value if set

Product

Property	Type	Max length	Description	Comment
Id	string	15 char	Product id/article number
Name	string	75 char	Product name
Description	string	nvarchar(max)	Product description	Longer description
ShortDescription	string	nvarchar(max)	Product short description	Shorter description suitable for instance when using on product pages.
ProductStatus	string	2 char	Product status	Used for determing if product availability will affect placing orders. Contact your sales contact for more information.
Type	string	2 char	Product type	Set up is individual for each of Pulsen’s clients. Contact your sales contact for more information.
Published	boolean		Determines if product is published or still being processed	Parameter set from Harmoney
Showable	boolean		Determines if product is showable	Parameter set from Harmoney
Orderable	boolean		Determines if product is orderable	Parameter set from Harmoney
OrderableInWebStore	boolean		Determines if product is orderable online	Parameter set from Harmoney
MinQuantity	decimal		Minimum order quantity	Parameter set from Harmoney
MaxQuantity	decimal		Maximum order quantity	Parameter set from Harmoney
Brand	string	75 char	Brand id
BrandDescription	string	nvarchar(max)	Brand description
Vat	decimal		Vat percentage
Unit	string	2 char	Quantity unit id
UnitDescription	string	50 char	Quantity unit name/description
ReleaseDate	DateTime		Date when product was first released(or should be released on)	Set in Harmoney, read only
NewsDate	DateTime		Date when product should be announced as news.	Set in Harmoney, read only
FriendlyUrl	string	100 char	Shortened URL
TotalTurnover	decimal		Total sales amount sum for this product	Returned from Harmoney, read only
SoldItems	decimal		Total quantity sold for this product	Returned from Harmoney, read only
WarehouseId	string	3 char	Warehouse id	Which warehouse that stores the product
ProductPrices	List of object		Contains all ProductPrice objects.	List of available prices, often depending on subcampaign
PriceText	string		PriceText	Description text of e.g. a campaign.
Price	decimal		Price	Primary price
ProductTexts	List of objects		Contains all ProductText objects
ItemList	List of objects		Contains all item objects	Items are variants of a product, for instance different colors or sizes
ReferenceProducts	List of objects		Contains all referenced product objects	Products referenced to this, for instance to suggest suitable accessories
AdditionalProducts	List of objects		Contains all additional product objects	Products referenced to this, for instance to suggest possible additional purchases
Response	object			See section Response

ProductPrice

Property	Type	Max length	Description	Comment
PriceType	Enum		Price type	See section PriceType
PriceGroup	Enum		Price group	See section PriceGroup
Price	decimal
PriceText	string	2 char	Price text id	Price description text, for instance for a campaign
Response	object			See section Response

ProductStock

Property	Type	Max length	Description	Comment
Item	Item		Item related to the stock value	See section Item
Amount	integer		Stock amount
Deliveries	List of objects		List of delivery objects	List if any inbound deliveries are expected for the product or item. See section Delivery
ProductStatus	Enum		Product status	See section ProductStatus
StorageProductStatus	Enum		Storage product status	See section StorageProductStatus
Response	object			See section Response

ProductText

Property	Type	Max length	Description	Comment
Id	string		Product id	Id of the product the text belongs to
Text	string	nvarchar(max)	Product text	The description text.

Receipt

Property	Type	Max length	Description	Comment
Id	string		Receipt id
CustomerId	string	9 char	The customer id
SalesChannel	string		The sales channel
SalesChannelName	string		Name of the sales channel, e.g. “store”.
Date	Date		Date created
Amount	double		The customer id in given sales channel
Type	string		The receipt type, e.g. return.
RowList			Contains all ReceiptRow objects	See section ReceiptRow
PaymentMethods	List of payment methods		List of payment methods.	See section PaymentMethodReceipt

ReceiptRow

Property	Type	Max length	Description	Comment
ArticleName	string		The article name
ArticleNameLanguage	string		Language of article name
ArticleNote	string		The article note.
ArticleId	string		Id of the article.
ArticleType	string		The type of article.
ArticleTypeName	string		The name of article type.
Attribute1	string		The attribute1.
Attribute1Name	string		Name of attribute1.
Attribute2	string		The attribute2.
Attribute2Name	string		Name of attribute2.
Discount	decimal		How much discount.
VatPercentage	decimal		The vat percentage.
Row	string		Receipt row.
VatCode	string		Vat Code.
PriceText	string		Price Text.
ReturnCode	string		Return code.
ReturnCodeName	string		Return code name.
Price	decimal		Price.
OrdinaryPrice	decimal		OrdinaryPrice.
ReceiptRowDiscounts	list		List of row discounts.	See section ReceiptRowDiscount

ReceiptRowDiscount

ReceiptRowDiscount gives information about which discounts that have been applied.

Property	Type	Max length	Description	Comment
DiscountId	string		The id of discount.
SerialNo	decimal		Serial number for receipt row discount.
Name	string		Name of row discount.
Description	string		Discount description
Type	string		Discount type
Category	decimal		Discount condition category
Level	decimal		Discount level
Amount	decimal		Didscount amount	Value depends on currency of the sales channel.

PaymentMethodReceipt

Property	Type	Max length	Description	Comment
Id	string		Payment method id
Name	string		Payment method name
Amount	decimal		Amount
CreditAmount	decimal		Credit amount

SalesChannelInfo

Property	Type	Max length	Description	Comment
SalesChannel	string		The sales channel
SalesChannelDesc	string		The description of the sales channel
Closed	bool?		Is the customer’s membership closed or not?
Blocked	bool?		Is the customer blocked or not?
CustomerId	string		The customer id in given sales channel

SavedOrder (GetSavedOrders:Order)

SavedOrderType = Enums.SavedOrderType.Order

The order is not delivered. Look at SavedOrder.Order.Properties.Status to see the status of the order (waitorder, partorder, revoked).

Below is the response from GetSavedOrders.

SavedOrder

Property	Type	Max length	Description	Comment
TotalValue	decimal		Total order value
OrderMethod	Enum		How the order was placed	Default value is OrderMethod.Internet
OrderDate	DateTime		Date when order was placed
IsOriginalOrder	boolean		Obsolete
SalesChannel	string		From which salechannel the order is placed
MoreInfoExist	boolean		If more info exist	If true, use GetOrderFromId to get the order rows.
SavedOrderType	Enum		The type of an SavedOrder	See section SavedOrderType
Response	object			See section Response

SavedOrder.Order

Property	Type	Max length	Description
Id	string	10 char	Order id.
PaymentMethod	Enum		See section PaymentMethod
TotalValue	decimal		Total order value
DeliveryValue			Order total for all orderrows that has DeliveryStatus=immediate.

SavedOrder.Order.Properties

Property	Type	Max length	Description
Status	Enum		See section OrderState
StatusDescription	string		Description of the state, ex packed, delivered depending on wms

SavedOrder (GetSavedOrders:Invoice)

SavedOrderType = Enums.SavedOrderType.Invoice

The order is delivered or in WMS-system. Look at SavedOrder.State to see the status of the order. The state can be different depending on the WMS system. State -> blank=on it´s way, 20=packed, 80, 90=canceled

Below is the response from GetSavedOrders.

SavedOrder

Property	Type	Max length	Description	Comment
Id	string	10 char	Invoice number
OrderDate	DateTime		Date when order was placed
InvoiceDate	DateTime		The invoice date
State	Enum		Status of the order	See section SavedOrderStatus
LastUpdatedDate	DateTime		Date when the order was last updated
IsOriginalOrder	boolean		Obsolete
TotalValue	decimal		Total order value
SalesChannel	string		From which salechannel the order is placed
OrderMethod	Enum		How the order was placed	Default value is OrderMethod.Internet
Balance	decimal		Total amount left to pay	If value is 0 the invoice is payed in full
InvoiceType	Enum		Type of invoice	See section InvoiceType
MoreInfoExist	boolean		If more info exist	If true, use GetOrderFromId to get the order rows.
Response	object			See section Response

SavedOrder.Order

Property	Type	Max length	Description	Comment
Id	string	10 char	Order id.
TotalValue	decimal		Total order value
Balance	decimal		Total amount left to pay	If value is 0 the invoice is payed
PaymentMethod	Enum		PaymentMethod	See section PaymentMethod

SavedOrder.Order.Properties

Property	Type	Max length	Description
StatusDescription	string		Description of the state, ex packed, delivered depending on wms

SavedOrder (GetSavedOrderFromId:Order)

SavedOrderType = Enums.SavedOrderType.Order

Use SavedOrder.Order.Id from GetSavedOrders when request GetSavedOrderFromId. CustomerId is not needed. You can´t do GetSavedOrderFromId when SavedOrder.Order.Properties.Status = Revoked.

Below is the response from GetSavedOrdersFromId.

SaveOrder

Property	Type	Max length	Description	Comment
LastUpdatedDate	DateTime		Date when the order was last updated

SavedOrder.Order

Property	Type	Max length	Description
Id	string	10 char	Order id.
Text	string		Ordertext connected to the order
PaymentMethod	Enum		PaymentMethod	See section PaymentMethod
OrderMethod	Enum		How the order was placed	Default value is OrderMethod.Internet See section OrderMethod
OrderDate	DateTime		Date when order was placed in Harmoney
OrderStop	string	char 2	The code for why the order has been stoped	Available codes are found
OrderStopDescription	string	char 40	The description of the order stop
CustomerId	string		Customer Id
OtherFee	decimal		Other fee than Fee and ShippingFee
Fee			Fee
ShippingFee			Shipping fee
Vat	decimal		Taxes and VAT for the whole order
Cod	decimal		COD fee	Cash on delivery
Discount	decimal		Total amount if discount
TotalValue	decimal		Total order value
CommodityValue	decimal		Delivery value

SavedOrder.Order.OrderTexts

Property	Type	Max length	Description
OrderTextRows			All ordertexts on an order

SavedOrder.Order.Properties

Property	Type	Max length	Description
Status	Enum		See section OrderState
StatusDescription	string		Description of the status

SavedOrder.Charges

Property	Type	Max length	Description
Charges	List of objects		List of charges drawn to pay for the order	See section Charge

SavedOrder.Order.RowList.OrderRow.Item

Property	Type	Max length	Description
Id	string	10 char	Order id.
Attribute1-5			Attribute values 1-5

SavedOrder.Order.RowList.OrderRow.OrderRowDiscounts

Property	Type	Max length	Description
Id	string	10 char	Discount id
Description			Discount description
Type			“Order”
Category			Discount category
Level			Discount level
Amount			Discount amount

SavedOrder.Order.PickUpLocation

Property	Type	Max length	Description
Id	string		PickupLocation id
Name			Description of the pickup location
Street			Street
Country			Country
DeliveryMethod			Delivery method

SavedOrder.Order.PickUpLocation.Service

Property	Type	Max length	Description
Id	string		PickupLocation service id
Name			Name of the pickup location service

SavedOrder.Order.TemporaryDeliveryAddress

Property	Type	Max length	Description
Type	Enum		TemporaryDeliveryAddress
FirstName	string		Description of the pickup location
LastName	string		Street
Street	string		Street
ZipCode	string		ZipCode
City	string		City
Country	Enum		Country

SavedOrder.Order.CreditCard

Property	Type	Max length	Description
MerchantId	string		Merchant Id
Name	string		Name
PanNumber	string		Payment number
Type	Enum		Type of card
ValidFrom	DateTime		ZipCode
ValidTo	DateTime		City

SavedOrder.Order.VoucherList.Voucher (type GiftVoucher)

Property	Type	Max length	Description
Amount	decimal		Amount on the giftcard
Id	int		Id of the giftcard
Charged	decimal		Amount used on the order

SavedOrder (GetSavedOrderFromId:Invoice)

SavedOrderType = Enums.SavedOrderType.Invoice

Use SavedOrder.Id from GetSavedOrders when request GetSavedOrderFromId. CustomerId is not needed.

Below is the response from GetSavedOrdersFromId.

SaveOrder

Property	Type	Max length	Description	Comment
Id	string	10 char	Invoice id.
OrderDate	DateTime		Date when order was placed
InvoiceDate	DateTime		The invoice date
State	Enum		Status	See section SavedOrderStatus
LastUpdatedDate	DateTime		Last date of payment
TotalValue	decimal		Total amount
Balance	decimal		Total amount left to pay	If value is 0 the invoice is payed in full
LastUpdatedDate	DateTime		Last updated
DeliveryMethod	string		Delivery method id
DeliveryMethodDescription	string		Description of delivery method
LastDateOfPayment	DateTime		Date when most recent payment was issued.
ReminderNo	string		The amount of times a customer have been reminded of an invoice
ReminderDate	DateTime?		The date of the last reminder
ReminderCharge	decimal		The charge of the reminder
ReminderAmount	decimal		The amount of the reminder
OCR	string		OCR text
DiscountAmount	decimal		Total amount of the discount of an invoice
InvoiceType	Enum		Type of invoice	See section InvoiceType
Response	object			See section Response

SaveOrder.Order

Property	Type	Max length	Description	Comment
Id	string	10 char	Order id.
CustomerId	string		Customer Id
TotalValue	decimal		Total order value
Vat	decimal		Vat amount
PaymentMethod	Enum		PaymentMethod	See section PaymentMethod
TrackingId			Tracking Id
ReturningTrackingId			Tracking id of the return

SaveOrder.Order.Properties

Property	Type	Max length	Description	Comment
Status	Enum		OrderState.Delivered	See section OrderSate

SaveOrder.Order.Customer

Property	Type	Max length	Description	Comment
CustomerId	string		Customer number
FirstName	string		First name
LastName	string		Last name
Address	object		List of Addresses (Invoice, Delivery)	See section Address

SavedOrder.Order.TemporaryDeliveryAddress

Property	Type	Max length	Description
Type	Enum		TemporaryDeliveryAddress
FirstName	string		Description of the pickup location
LastName	string		Street
Street	string		Street
ZipCode	string		ZipCode
City	string		City
Country	Enum		Country

SavedOrder.Order.PickUpLocation

Property	Type	Max length	Description
Id	string		PickupLocation id
Name			Description of the pickup location
Street			Street
Country			Country
DeliveryMethod			Delivery method

SavedOrder.Order.OrderTexts

Property	Type	Max length	Description
OrderTextRows			All ordertexts on an order

SavedOrder.Order.RowList.OrderRow.Item

Property	Type	Max length	Description
Id	string	10 char	Order id.
Attribute1-5			Attribute values 1-5

SavedOrder.Order.RowList.OrderRow

Property	Type	Max length	Description
Name	string		Order row name or description
ExtendedName	string		Extended order row name
Quantity	int		Quantity
Price	decimal		Price
OrdinaryPrice	decimal		Ordinary price
Discount	decimal		Discount of the order row
Sum	decimal		Sum value
ReturnQuality	int		Number of articles that has been returned
ReturnCode	string		The return code as of why the item has been returned
DiscountDesciption	string		Price text
VatCode	string		Vat code id
VatPercentage	int		Vat percentage
OrderId	string		Order number
DeliveryDate	DateTime		When the invoice was created

SavedOrder.Order.RowList.OrderRow.OrderRowDiscounts

Property	Type	Max length	Description
Id	string	10 char	Discount id
Description			Discount description
Type			“Order”
Category			Discount category
Level			Discount level
Amount			Discount amount

SavedOrder.Charges

Property	Type	Max length	Description
Charges	List of objects		List of charges drawn to pay for the order	See section Charge

SubCampaign

Property	Type	Max length	Description	Comment
Id	string	7 char	Main campaign id
CampaignId	string	7 char	SubCampaign id
Name	string	100 char	Campaign description
Type	string	3 char	Campaign type
DiscountConditionId	string	7 char	Discount condition id
StartDate	DateTime		Date campaign is valid from
EndDate	DateTime		Date campaign is valid to.
Response	object			See section Response

Voucher

Property	Type	Max length	Description	Comment
Id	string	10 char	Voucher id	Inherited to subclasses
Response	object			See section Response

DefaultCreditCard

Property	Type	Max length	Default value	Comment
CustomerId	string	9 char	Empty string	Customer id
Paymentmethod	Enum		Enums.PaymentMethod. GenericCreditCard	See enumerations section for PaymentMethod
PanNumber	string	20 char	Empty string	The credit card number
Type	Enum		Enums.CreditCardType.VISA	Contact your Pulsen contact for valid values
ValidFrom	DateTime		DateTime.MinValue
ValidTo	DateTime		DateTime.MinValue	The credit cards valid-to date. Must be filled in.
ExternalReference	string		Empty string	The external reference for a certain credit card.
ExternalPartner	Enum		Dibs	The external partner for a certain credit card.
MerchantId	string	20 char	Empty string	Used for credit card authorizations.
Response	object			See section Response

OrderText

Property	Type	Description
Type	string	Type of text
Text	string	Used i.e. for adding custom message to an Order

MiscInfo

Property	Type	Default value	Comment
MiscInfoType	Enum	Enums.MiscInfoType.Unknown	The type of miscellaneous info type, i.e. Voyado
MiscInfoValue	string	null	The actual value belong to miscellaneous info, i.e. Voyado id