SetProperties

Command, Introduced in version 2.18

POST https://localhost:8001/sv/001.1/api/v1/Sales/Customers/SetProperties

Updates a customer.

Returns EntityCommandResponse

The root entity id of the response is the business key identifier of the updated customer. References Customers

The entity id of the response is the same as the root entity id.

Required permission

Modify customer

Properties

Name Type Summary Introduced in
CustomerId Int64 The business key identifier of the customer to update.

References Customers

  • Mandatory
Name StringInput The name of the customer.
SetNameOnAddresses NotNullBooleanInput If Name is specified, this determines whether the addressee should be updated on the customer's addresses.

  • true by default
 Introduced in version 24.1
Code StringInput The human readable identifier of the customer.
AlternativeName StringInput The alternative name of the customer.
CorporationIdentificationNumber StringInput The corporation identification number of the customer.
PersonalNumber StringInput The personal number of the customer.
IsPrivateCustomer BooleanInput Specifies if the customer is a private person.
VatNumber StringInput The VAT number of the customer.
AccountManagerId LongInput The business key identifier of the customer's account manager.

References Persons
ActualCustomerProbabilityId LongInput The business key identifier of the customer's actualization probability.

References Probabilities
Alias StringInput The alias code of the customer.
AlloyCost IntegerInput The alloy cost associated with the customer.
ApplyBankCharge BooleanInput Specifies if bank charge should be applied for the customer.
ApplyInvoicingCharge BooleanInput Specifies if invoicing charge should be applied for the customer.
ApplyReminderCharge BooleanInput Specifies if reminder charge should be applied for the customer.
AttachDatafileWithOrder BooleanInput Specifies if data file should be attached with orders for the customer.
AttachDatafileWithInvoice BooleanInput Specifies if data file should be attached with invoices for the customer.
AttachDatafileWithCase BooleanInput Specifies if data file should be attached with cases for the customer.
AttachDatafileWithPart BooleanInput Specifies if data file should be attached with parts for the customer.
AttachDatafileWithDispatchAdvice BooleanInput Specifies if data file should be attached with dispatch advice for the customer.
BankChargeAmount DecimalInput The bank charge amount of the customer.
BankGiroNo StringInput The bank giro number of the customer.
CategoryString StringInput The category string of the customer.
ConfigurationPriceListId LongInput The business key identifier of the configuration price list that the customer belongs to.

References PriceLists
CreditLimit DecimalInput The credit limit of the customer.
CurrencyId LongInput The business key identifier of the customer's currency.

References
DistrictId LongInput The business key identifier of the district that the customer
belongs to.

References CustomerDistricts
DateForTransitionToActualContact DateTimeInput The date/time when transition to actual contact was made for the customer.
Discount DecimalInput The general discount of the customer.
DiscountCategoryId LongInput The business key identifier of the discount category that applies for the
customer.

References DiscountCategories
DefaultOrderPrintoutVia IntegerInput The preferred order printout method of the customer.
DeliveryInstruction StringInput The delivery instruction of the customer.
DefaultInvoiceStatusPending BooleanInput Specifies if invoices should be pending by default for the customer.
EdiCode StringInput The EDI code of the customer.
Factoring BooleanInput Specifies if factoring applies for the customer.
GracePeriod IntegerInput The grace period of the customer.
InterestType IntegerInput Specifies the interest type of the customer.

  • InterestInvoice: 0
  • NextRegularInvoice: 1
  • None: 2
IsCasualCustomer BooleanInput Specifies if the customer is a stray customer.
InterestInvoiceDays IntegerInput Specifies the interest invoice days for the customer.
InsuranceCost DecimalInput The insurance cost specified for the customer.
InvoiceCustomerId LongInput The business key identifier of the invoice customer of the customer.

References Customers
InvoicePrintoutMethod IntegerInput The customer's preferred printout method for invoices.

  • Printer: 0
  • Email: 1
  • Edi: 2
  • None: 9
InvoicePrintoutOccasion IntegerInput Specifies when invoices should be printed for the customer.

  • AfterDeliveryReport: 0
  • OnDeliveryReportPreliminary: 1
  • OnDeliveryReportDefinite: 2
LanguageId LongInput The business key identifier of the customer's preferred language.

References LanguageCodes
LatePaymentFee DecimalInput The late payment fee of the customer.
NumberOfInvoiceCopies IntegerInput The number of invoice copies that should be produced for the customer.
OurCodeByYou StringInput The supplier code assigned to us by the customer.
PalletRegistrationNo StringInput The customer's pallet registration number.
PaymentTermId LongInput The business key identifier of the customer's payment term.

References PaymentTerms
PlusGiroNo StringInput The PlusGiro number of the customer.
PriceListId LongInput The business key identifier of the customer's price list.

References PriceLists
Priority IntegerInput The priority of the customer.
ProformaInvoicePrintoutOccasion IntegerInput Specifies when proforma invoices should be printed for the customer.

  • AfterDeliveryReport: 0
  • OnDeliveryReport: 1
ResellerId LongInput The business key identifier of the customer's reseller.

References Persons
RoundOff BooleanInput Specifies if round off applies for the customer.
SellerId LongInput The business key identifier of the customer's seller.

References Persons
ServiceAgreementId LongInput The business key identifier of the customer's service agreement.

References ServiceAgreement
ShowPartStatisticalGoodsCodeAndCountryOfOriginInForms IntegerInput Specifies which documents should display statistical goods codes
for the customer.

  • None: 0
  • Quote: 1
  • Acknowledgement: 2
  • DeliveryNote: 4
  • Invoice: 8
  • ProFormaInvoice: 16
ShowPartStatisticalGoodsCodeInForms NotNullIntegerInput Specifies which documents should display statistical goods codes
for the customer.

  • None: 0
  • Quote: 1
  • Acknowledgement: 2
  • DeliveryNote: 4
  • Invoice: 8
  • ProFormaInvoice: 16
 Introduced in version 24.3
ShowCountryOfOriginInForms NotNullIntegerInput Specifies which documents should show country of origin for the customer.

  • None: 0
  • Quote: 1
  • Acknowledgement: 2
  • DeliveryNote: 4
  • Invoice: 8
  • ProFormaInvoice: 16
 Introduced in version 24.3
ShowPartWeightInForms IntegerInput Specifies which documents should show part weight for the customer.

  • None: 0
  • Quote: 1
  • Acknowledgement: 2
  • DeliveryNote: 4
  • Invoice: 8
  • ProFormaInvoice: 16
StatusId LongInput The business key identifier of the customer's status.

References CustomerStatuses
ToleranceForLateDelivery IntegerInput The tolerance for late delivery to set in days.
ToleranceForEarlyDelivery IntegerInput The tolerance for early delivery to set in days.
TypeId LongInput The business key identifier of the customer's type.

References CustomerTypes
Url StringInput The URL of the customer.
UseComprehensiveInvoices BooleanInput Specifies if comprehensive invoices should be used for the customer.
ComprehensiveInvoiceGroupingMode IntegerInput Specifies if comprehensive invoices should be used for the customer and if so, what they should be grouped on.

  • None: 0
  • Customer: 1
  • Order: 2
  • DeliveryNote: 3
UseDeliveryNoteCollectionFormReport BooleanInput Specifies if comprehensive delivery notes should be used for the customer.
UseForwardRate BooleanInput Specifies if forward rate should be used for the customer.
UseInvoiceCustomersVatNumber BooleanInput Specifies if VAT number should be taken via the invoice customer.
UseReminder BooleanInput Specifies if reminders should be enabled for the customer.
VatRateId LongInput The business key identifier of the customer's VAT rate.

References VatRates

  • Obsolete since version 23.6 (Replaced by VatGroupId on DeliveryAddress)
ValidityTimeId LongInput The business key identifier of the customer's validity time.

References ValidityTimes
PaymentPlanTemplateId LongInput The business key identifier of the customer's payment plan template.

References
Introduced in version 2.48
TimeZone StringInput The time zone of the customer. Specified as a time zone identifier (e.g. "W. Europe Standard Time").

  • Max length is 80
 Introduced in version 22.1
DecimalSymbol StringInput The decimal symbol of the customer.

  • Max length is 1
 Introduced in version 22.1
DateDisplayFormat NotNullIntegerInput The date display format of the customer.

  • YYYYMMDD_Dash: 1
  • YYMMDD_Dash: 2
  • DDMMYYYY_Dash: 3
  • DDMMYY_Dash: 4
  • YYYYMMDD_Slash: 5
  • YYMMDD_Slash: 6
  • MMDDYYYY_Slash: 7
  • MMDDYY_Slash: 8
  • MDYY_Slash: 9
  • DDMMYYYY_Slash: 10
  • DDMMYY_Slash: 11
  • DMMYY_Slash: 12
  • YYYYMMDD_Dot: 13
  • DDMMYYYY_Dot: 14
  • DDMMYY_Dot: 15
  • DDMYY_Dot: 16
  • DMMYYYY_Dot: 17
  • DMMYY_Dot: 18
  • DMYYYY_Dot: 19
  • DMYY_Dot: 20
  • YYWWD: 21
 Introduced in version 22.1
UseEInvoicing NotNullBooleanInput Specifies if the customer uses e-invoicing.
 Introduced in version 22.1
EInvoiceElectronicAddressIdentifier StringInput The e-invoice electronic address identifier of the customer.

  • Max length is 6
 Introduced in version 22.1
EInvoiceId StringInput The e-invoice id of the customer.

  • Max length is 30
 Introduced in version 22.1
PreliminaryPickingList NotNullBooleanInput Specifies if the customer should apply preliminary picking list.
 Introduced in version 22.6
IncludeInDeliveryAnalysis NotNullBooleanInput Specifies if the customer is included in delivery analysis.
 Introduced in version 22.6
CustomerAccountGroupId NotNullLongInput The business key identifier of the customer's active delivery address account group.

References CustomerAccountGroups

 Introduced in version 22.6
VatGroupId NotNullLongInput The business key identifier of the VAT group that the delivery address belongs to.

References VatGroups.

 Introduced in version 22.6
CurrencyExchangeTypeId NotNullLongInput The business key identifier of the customer's currency exchange type.

 Introduced in version 22.9
IsInternal NotNullBooleanInput Specifies if the customer is internal.
 Introduced in version 23.9
DefaultReferenceId NotNullLongInput The business key identifier of the customer's default business contact
reference.

References BusinessContactReferences
 Introduced in version 24.2
EmployeeSpanId LongInput The business key identifier of employee span of customer
 Introduced in version 24.3
DeliveryNoteNumberWhenDeliveryPlanning NotNullBooleanInput The delivery note number when delivery planning of the customer.
 Introduced in version 25.2

Example

{
  "CustomerId": 0,
  "Name": null,
  "SetNameOnAddresses": null,
  "Code": null,
  "AlternativeName": null,
  "CorporationIdentificationNumber": null,
  "PersonalNumber": null,
  "IsPrivateCustomer": null,
  "VatNumber": null,
  "AccountManagerId": null,
  "ActualCustomerProbabilityId": null,
  "Alias": null,
  "AlloyCost": null,
  "ApplyBankCharge": null,
  "ApplyInvoicingCharge": null,
  "ApplyReminderCharge": null,
  "AttachDatafileWithOrder": null,
  "AttachDatafileWithInvoice": null,
  "AttachDatafileWithCase": null,
  "AttachDatafileWithPart": null,
  "AttachDatafileWithDispatchAdvice": null,
  "BankChargeAmount": null,
  "BankGiroNo": null,
  "CategoryString": null,
  "ConfigurationPriceListId": null,
  "CreditLimit": null,
  "CurrencyId": null,
  "DistrictId": null,
  "DateForTransitionToActualContact": null,
  "Discount": null,
  "DiscountCategoryId": null,
  "DefaultOrderPrintoutVia": null,
  "DeliveryInstruction": null,
  "DefaultInvoiceStatusPending": null,
  "EdiCode": null,
  "Factoring": null,
  "GracePeriod": null,
  "InterestType": null,
  "IsCasualCustomer": null,
  "InterestInvoiceDays": null,
  "InsuranceCost": null,
  "InvoiceCustomerId": null,
  "InvoicePrintoutMethod": null,
  "InvoicePrintoutOccasion": null,
  "LanguageId": null,
  "LatePaymentFee": null,
  "NumberOfInvoiceCopies": null,
  "OurCodeByYou": null,
  "PalletRegistrationNo": null,
  "PaymentTermId": null,
  "PlusGiroNo": null,
  "PriceListId": null,
  "Priority": null,
  "ProformaInvoicePrintoutOccasion": null,
  "ResellerId": null,
  "RoundOff": null,
  "SellerId": null,
  "ServiceAgreementId": null,
  "ShowPartStatisticalGoodsCodeAndCountryOfOriginInForms": null,
  "ShowPartStatisticalGoodsCodeInForms": null,
  "ShowCountryOfOriginInForms": null,
  "ShowPartWeightInForms": null,
  "StatusId": null,
  "ToleranceForLateDelivery": null,
  "ToleranceForEarlyDelivery": null,
  "TypeId": null,
  "Url": null,
  "UseComprehensiveInvoices": null,
  "ComprehensiveInvoiceGroupingMode": null,
  "UseDeliveryNoteCollectionFormReport": null,
  "UseForwardRate": null,
  "UseInvoiceCustomersVatNumber": null,
  "UseReminder": null,
  "VatRateId": null,
  "ValidityTimeId": null,
  "PaymentPlanTemplateId": null,
  "TimeZone": null,
  "DecimalSymbol": null,
  "DateDisplayFormat": null,
  "UseEInvoicing": null,
  "EInvoiceElectronicAddressIdentifier": null,
  "EInvoiceId": null,
  "PreliminaryPickingList": null,
  "IncludeInDeliveryAnalysis": null,
  "CustomerAccountGroupId": null,
  "VatGroupId": null,
  "CurrencyExchangeTypeId": null,
  "IsInternal": null,
  "DefaultReferenceId": null,
  "EmployeeSpanId": null,
  "DeliveryNoteNumberWhenDeliveryPlanning": null
}