Customers

Queryable, Introduced in version 2.18

GET https://localhost:8001/sv/001.1/api/v1/Sales/Customers

Represents a customer.

GUID

9A9B110E-D5B5-410D-AFEE-C397747EBA77

Required permission

Show customer

Properties

Name Type Summary Introduced in
Id Int64 The business key identifier of the customer.
Name String The name of the customer.

  • Max length is 100
Code String The human readable identifier of the customer.

  • Not nullable
  • Max length is 10
  • Unique
AlternativeName String The alternative name of the customer.

  • Max length is 100
CorporationIdentificationNumber String The corporation identification number of the customer.

  • Max length is 30
PersonalNumber String The personal number of the customer.

  • Max length is 13
IsPrivateCustomer Boolean Specifies if the customer is a private person.
VatNumber String The VAT number of the customer.

  • Max length is 30
DeliveryAddresses DeliveryAddresses[] The delivery addresses of the customer.

  • Expandable
ActiveDeliveryAddressId Int64 The business key identifier of the customer's active delivery address.

References DeliveryAddresses
ActiveDeliveryAddress DeliveryAddresses The active delivery address of the customer.

  • Expandable
References BusinessContactReferences[] The business contact references belonging to the customer.

  • Expandable
DefaultReferenceId Int64? The business key identifier of the customer's default business contact
reference.

References BusinessContactReferences
DefaultReference BusinessContactReferences The default reference of the customer.

  • Expandable
Alias String The alias code of the customer.

  • Max length is 10
AlloyCost Int32 The alloy cost associated with the customer.
ApplyBankCharge Boolean Specifies if bank charge should be applied for the customer.
ApplyInvoicingCharge Boolean Specifies if invoicing charge should be applied for the customer.
ApplyReminderCharge Boolean Specifies if reminder charge should be applied for the customer.
AccountManagerId Int64? The business key identifier of the customer's account manager.

References Persons
AccountManager Persons The account manager of the customer.

  • Expandable
ActiveDeliveryAddressAccountGroupId Int64? The business key identifier of the customer's active delivery address account group.

References CustomerAccountGroups
 Introduced in version 2.28
ActiveDeliveryAddressAccountGroup CustomerAccountGroups The active delivery address account group of the customer.

  • Expandable
 Introduced in version 2.28
ActualCustomerProbabilityId Int64? The business key identifier of the customer's actualization probability.

References Probabilities
ActualCustomerProbability Probabilities The actualization probability of the customer.

  • Expandable
AttachDatafileWithOrder Boolean Specifies if data file should be attached with orders for the customer.
AttachDatafileWithInvoice Boolean Specifies if data file should be attached with invoices for the customer.
AttachDatafileWithCase Boolean Specifies if data file should be attached with cases for the customer.
 Introduced in version 22.2
AttachDatafileWithPart Boolean Specifies if data file should be attached with parts for the customer.
AttachDatafileWithDispatchAdvice Boolean Specifies if data file should be attached with dispatch advice for the customer.
BankChargeAmount Decimal The bank charge amount of the customer.
BankGiroNo String The bank giro number of the customer.

  • Max length is 15
BlockedById Int64? The business key identifier of the application user that blocked the entity.
BlockedBy ApplicationUsers The application user that blocked the customer.

  • Expandable
BlockedStatus Int32 The block status of the entity.

  • None: 0
  • Message: 1
  • Blocked: 2
BlockedContextType Int32 Specifies in which contexts that the customer is blocked.

  • None: 0
  • Register: 1
  • Report: 2
  • RegisterSupplierInvoice: 4
  • Payments: 8

  • Bitmask
BlockMessageId Int64? The business key identifier of the entity block message comment.

References Comments.
BlockMessage Comments The block message that applies for the customer.

  • Expandable
BlockedFromDate DateTimeOffset? The date when the entity starts being blocked.
BlockedToDate DateTimeOffset? The date when the entity stops being blocked.
CategoryString String The category string of the customer.

  • Max length is 15
CommentId Int64? The business key identifier of the customer's comment.

References Comments
Comment Comments The comment of the customer.

  • Expandable
CompanyId Int64 The business key identifier of the company that the customer belongs to.
ConfigurationPriceListId Int64? The business key identifier of the configuration price list that the customer belongs to.

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

References
Currency Currencies The currency of the customer.

  • Expandable
 Introduced in version 2.28
DateDisplayFormat Int32 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 2.28
DecimalSymbol String The decimal symbol of the customer.

  • Max length is 1
 Introduced in version 2.28
DeliveryHorizon Int64? The delivery horizon of the customer.
 Introduced in version 2.28
DeliveryNoteNumberWhenDeliveryPlanning Boolean The delivery note number when delivery planning of the customer.
 Introduced in version 2.28
DistrictId Int64? The business key identifier of the district that the customer
belongs to.

References CustomerDistricts
District CustomerDistricts The district that the customer belongs to.

  • Expandable
DateForTransitionToActualContact DateTimeOffset The date/time when transition to actual contact was made for the customer.
Discount Decimal? The general discount of the customer.
DiscountCategoryId Int64? The business key identifier of the discount category that applies for the
customer.

References DiscountCategories
DiscountCategory DiscountCategories The discount category that applies for the customer.

  • Expandable
DefaultOrderPrintoutVia Int32 The preferred order printout method of the customer.

  • Printer: 0
  • Email: 1
  • Edi: 2
  • None: 9
PrintProformaInvoiceVia Int32 The preferred Proforma printout method of the customer.

  • Printer: 0
  • Email: 1
  • Edi: 2
  • None: 9
PrintPaymentReminderVia Int32 The preferred payment reminder printout method of the customer.

  • Printer: 0
  • Email: 1
  • Edi: 2
  • None: 9
DeliveryInstruction String The delivery instruction of the customer.

  • Max length is 80
DefaultInvoiceStatusPending Boolean Specifies if invoices should be pending by default for the customer.
EdiCode String The EDI code of the customer.

  • Max length is 80
  • Obsolete since version 2.32 (Replaced by OtherCustomerNumbers)
EInvoiceElectronicAddressIdentifier String The e-invoice electronic address identifier of the customer.

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

  • Max length is 30
 Introduced in version 2.28
EInvoiceOperatorCode String The e-invoice operator code of the customer.

  • Max length is 30
 Introduced in version 2.28
Factoring Boolean Specifies if factoring applies for the customer.
GracePeriod TimeSpan? The grace period of the customer.
HideDiscountOnProformaInvoice Boolean Specifies if the customer hides discount on proforma invoices.
 Introduced in version 2.28
IncludeInDeliveryAnalysis Boolean? Specifies if the customer is included in delivery analysis.
 Introduced in version 2.28
InvoiceAddressId Int64? The business key identifier of the customer's invoice address.

If there is no value here use MailingAddressId.
InvoiceAddress Addresses The invoice address of the customer.

If there is no value here use MailingAddress.

  • Expandable
InterestType Int32 Specifies the interest type of the customer.

  • InterestInvoice: 0
  • NextRegularInvoice: 1
  • None: 2
IsCasualCustomer Boolean Specifies if the customer is a stray customer.
InterestInvoiceDays Int32? Specifies the interest invoice days for the customer.
InsuranceCost Decimal The insurance cost specified for the customer.
InvoiceCustomerId Int64? The business key identifier of the invoice customer of the customer.

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

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

  • AfterDeliveryReport: 0
  • OnDeliveryReportPreliminary: 1
  • OnDeliveryReportDefinite: 2
IsInternal Boolean Specifies if the customer is internal.
 Introduced in version 2.28
LanguageId Int64 The business key identifier of the customer's preferred language.

References LanguageCodes
Language LanguageCodes The language of the customer.
 Introduced in version 2.28
LatePaymentFee Decimal? The late payment fee of the customer.
MailingAddressId Int64 The business key identifier of the customer's mailing address.

If InvoiceAddressId does not have a value this is also used as invoice adress.
MailingAddress Addresses The mailing address of the customer.

If InvoiceAddressId does not have a value this is also used as invoice adress.

  • Expandable
NumberOfInvoiceCopies Int32? The number of invoice copies that should be produced for the customer.
OurCodeByYou String The supplier code assigned to us by the customer.

  • Max length is 20
PalletRegistrationNo String The customer's pallet registration number.

  • Max length is 35
PartialDeliveryType Int32 The partial delivery type of the customer.

  • None: 0
  • PerOrder: 1
  • PerRow: 2
  • NoneDelete: 3 (Introduced in version 22.8)
  • PerDeliveryDate: 4 (Introduced in version 25.3)
 Introduced in version 2.28
PaymentPlanTemplateId Int64? The business key identifier of the customer's payment plan template.

References
Introduced in version 2.28
PaymentPlanTemplate PaymentPlanTemplates The payment plan template of the customer.

  • Expandable
 Introduced in version 2.28
PaymentTermId Int64 The business key identifier of the customer's payment term.

References PaymentTerms
PaymentTerm PaymentTerms The payment term of the customer.

  • Expandable
PlusGiroNo String The PlusGiro number of the customer.

  • Max length is 15
PriceListId Int64 The business key identifier of the customer's price list.

References PriceLists
Priority Int32 The priority of the customer.
PickingListCommentId Int64? The business key identifier of the customer's picking list comment.

References Comments
PickingListComment Comments The picking list comment of the customer.

  • Expandable
ProformaInvoicePrintoutOccasion Int32 Specifies when proforma invoices should be printed for the customer.

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

References Persons
Reseller Resellers The reseller of the customer.

  • Expandable
RoundOff Boolean Specifies if round off applies for the customer.
SellerId Int64? The business key identifier of the customer's seller.

References Persons
Seller Persons The seller of the customer.

  • Expandable
ServiceAgreementId Int64? The business key identifier of the customer's service agreement.

References ServiceAgreement
ServiceTaxNumber String The service tax number of the customer.

  • Max length is 30
 Introduced in version 2.28
ShowPartStatisticalGoodsCodeAndCountryOfOriginInForms Int32 New properties available: ShowPartStatisticalGoodsCodeInForms and ShowCountryOfOriginInForms.

Try to use new properties instead.

  • None: 0
  • Quote: 1
  • Acknowledgement: 2
  • DeliveryNote: 4
  • Invoice: 8
  • ProFormaInvoice: 16

  • Obsolete since version 24.3 (Replaced by ShowPartStatisticalGoodsCodeInForms and ShowCountryOfOriginInForms)
  • Bitmask
ShowPartStatisticalGoodsCodeInForms Int32 Specifies which documents should display statistical goods codes
for the customer.

  • None: 0
  • Quote: 1
  • Acknowledgement: 2
  • DeliveryNote: 4
  • Invoice: 8
  • ProFormaInvoice: 16

  • Bitmask
 Introduced in version 24.3
ShowCountryOfOriginInForms Int32 Specifies which documents should show country of origin for the customer.

  • None: 0
  • Quote: 1
  • Acknowledgement: 2
  • DeliveryNote: 4
  • Invoice: 8
  • ProFormaInvoice: 16

  • Bitmask
 Introduced in version 24.3
ShowPartWeightInForms Int32 Specifies which documents should show part weight for the customer.

  • None: 0
  • Quote: 1
  • Acknowledgement: 2
  • DeliveryNote: 4
  • Invoice: 8
  • ProFormaInvoice: 16

  • Bitmask
StatusId Int64 The business key identifier of the customer's status.

References CustomerStatuses
Status CustomerStatuses The status of the customer.

  • Expandable
TimeZone String The time zone of the customer. Specified as a time zone identifier (e.g. "W. Europe Standard Time").
 Introduced in version 2.29
TimeZoneOffset Decimal The time zone offset of the customer.

  • Obsolete since version 2.29 (Replaced by TimeZone)
 Introduced in version 2.28
ToleranceForLateDelivery TimeSpan? The customer's tolerance for late delivery.
ToleranceForEarlyDelivery TimeSpan? The customer's tolerance for early delivery.
TypeId Int64? The business key identifier of the customer's type.

References CustomerTypes
Type CustomerTypes The type of the customer.

  • Expandable
Url String The URL of the customer.

  • Max length is 255
UseBundling Boolean? Specifies if the customer uses bundling.
 Introduced in version 2.28
UseComprehensiveInvoices Boolean Specifies if comprehensive invoices should be used for the customer.

  • Obsolete since version 2.41 (Replaced by ComprehensiveInvoiceGroupingMode)
ComprehensiveInvoiceGroupingMode Int32 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
 Introduced in version 2.41
UseDeliveryNoteCollectionFormReport Boolean Specifies if comprehensive delivery notes should be used for the customer.
UseEInvoicing Boolean Specifies if the customer uses e-invoicing.
 Introduced in version 2.28
UseForwardRate Boolean Specifies if forward rate should be used for the customer.
UseInvoiceCustomersVatNumber Boolean Specifies if VAT number should be taken via the invoice customer.
UsePackageSpecification Boolean? Specifies if the customer uses package specification.
 Introduced in version 2.28
UseReminder Boolean Specifies if reminders should be enabled for the customer.
VatRateId Int64? The business key identifier of the customer's VAT rate.

References VatRates

  • Obsolete since version 23.6 (Replaced by VatGroupId on DeliveryAddress)
VatRate VatRates The VAT rate of the customer.

  • Expandable
  • Obsolete since version 23.6 (Replaced by VatGroup from DeliveryAddress)
ValidityTimeId Int64 The business key identifier of the customer's validity time.

References ValidityTimes
ValidityTime ValidityTimes The validity time of the customer.
Version Int32 The version of the customer.
VisitingAddressId Int64? The business key identifier of the customer's visiting address.

References Addresses
VisitingAddress Addresses The visiting address of the customer.

  • Expandable
CustomerPartLinks CustomerPartLinks[] The part links defined for the customer.

  • Expandable
CaseEntries CaseEntry[] A collection of case entries that belong to the customer.

  • Expandable
OtherCustomerNumbers OtherCustomerNumbers[] Available other customer numbers. Mainly used as EDI identifiers.

  • Expandable
 Introduced in version 2.32
CommunicationAddresses CommunicationAddresses[] The communication addresses for the customer.

  • Expandable
 Introduced in version 2.50
ExtraFields ExtraFields[] A collection of extra field values for the customer.

  • Expandable
 Introduced in version 2.54
PreliminaryPickingList Boolean Specifies if the customer should apply preliminary picking list.
 Introduced in version 22.6
CurrencyExchangeTypeId Int64 The business key identifier of the customer's currency exchange type.

 Introduced in version 22.9
RootId Int64 The business key identifier of the customer's root entity.

  • References CustomerRoot
 Introduced in version 24.3
EmployeeSpanId Int64? The business key identifier of employee span of customer
 Introduced in version 24.3
EmployeeSpan CustomerEmployeeSpans The employee span of customer

  • Expandable
 Introduced in version 24.3

Example

{
  "Id": 0,
  "Name": null,
  "Code": null,
  "AlternativeName": null,
  "CorporationIdentificationNumber": null,
  "PersonalNumber": null,
  "IsPrivateCustomer": false,
  "VatNumber": null,
  "DeliveryAddresses": null,
  "ActiveDeliveryAddressId": 0,
  "ActiveDeliveryAddress": null,
  "References": null,
  "DefaultReferenceId": null,
  "DefaultReference": null,
  "Alias": null,
  "AlloyCost": 0,
  "ApplyBankCharge": false,
  "ApplyInvoicingCharge": false,
  "ApplyReminderCharge": false,
  "AccountManagerId": null,
  "AccountManager": null,
  "ActiveDeliveryAddressAccountGroupId": null,
  "ActiveDeliveryAddressAccountGroup": null,
  "ActualCustomerProbabilityId": null,
  "ActualCustomerProbability": null,
  "AttachDatafileWithOrder": false,
  "AttachDatafileWithInvoice": false,
  "AttachDatafileWithCase": false,
  "AttachDatafileWithPart": false,
  "AttachDatafileWithDispatchAdvice": false,
  "BankChargeAmount": 0.0,
  "BankGiroNo": null,
  "BlockedById": null,
  "BlockedBy": null,
  "BlockedStatus": 0,
  "BlockedContextType": 0,
  "BlockMessageId": null,
  "BlockMessage": null,
  "BlockedFromDate": null,
  "BlockedToDate": null,
  "CategoryString": null,
  "CommentId": null,
  "Comment": null,
  "CompanyId": 0,
  "ConfigurationPriceListId": null,
  "CreditLimit": 0.0,
  "CurrencyId": 0,
  "Currency": null,
  "DateDisplayFormat": 0,
  "DecimalSymbol": null,
  "DeliveryHorizon": null,
  "DeliveryNoteNumberWhenDeliveryPlanning": false,
  "DistrictId": null,
  "District": null,
  "DateForTransitionToActualContact": "0001-01-01T00:00:00+00:00",
  "Discount": null,
  "DiscountCategoryId": null,
  "DiscountCategory": null,
  "DefaultOrderPrintoutVia": 0,
  "PrintProformaInvoiceVia": 0,
  "PrintPaymentReminderVia": 0,
  "DeliveryInstruction": null,
  "DefaultInvoiceStatusPending": false,
  "EdiCode": null,
  "EInvoiceElectronicAddressIdentifier": null,
  "EInvoiceId": null,
  "EInvoiceOperatorCode": null,
  "Factoring": false,
  "GracePeriod": null,
  "HideDiscountOnProformaInvoice": false,
  "IncludeInDeliveryAnalysis": null,
  "InvoiceAddressId": null,
  "InvoiceAddress": null,
  "InterestType": 0,
  "IsCasualCustomer": false,
  "InterestInvoiceDays": null,
  "InsuranceCost": 0.0,
  "InvoiceCustomerId": null,
  "InvoicePrintoutMethod": 0,
  "InvoicePrintoutOccasion": 0,
  "IsInternal": false,
  "LanguageId": 0,
  "Language": null,
  "LatePaymentFee": null,
  "MailingAddressId": 0,
  "MailingAddress": null,
  "NumberOfInvoiceCopies": null,
  "OurCodeByYou": null,
  "PalletRegistrationNo": null,
  "PartialDeliveryType": 0,
  "PaymentPlanTemplateId": null,
  "PaymentPlanTemplate": null,
  "PaymentTermId": 0,
  "PaymentTerm": null,
  "PlusGiroNo": null,
  "PriceListId": 0,
  "Priority": 0,
  "PickingListCommentId": null,
  "PickingListComment": null,
  "ProformaInvoicePrintoutOccasion": 0,
  "ResellerId": null,
  "Reseller": null,
  "RoundOff": false,
  "SellerId": null,
  "Seller": null,
  "ServiceAgreementId": null,
  "ServiceTaxNumber": null,
  "ShowPartStatisticalGoodsCodeAndCountryOfOriginInForms": 0,
  "ShowPartStatisticalGoodsCodeInForms": 0,
  "ShowCountryOfOriginInForms": 0,
  "ShowPartWeightInForms": 0,
  "StatusId": 0,
  "Status": null,
  "TimeZone": null,
  "TimeZoneOffset": 0.0,
  "ToleranceForLateDelivery": null,
  "ToleranceForEarlyDelivery": null,
  "TypeId": null,
  "Type": null,
  "Url": null,
  "UseBundling": null,
  "UseComprehensiveInvoices": false,
  "ComprehensiveInvoiceGroupingMode": 0,
  "UseDeliveryNoteCollectionFormReport": false,
  "UseEInvoicing": false,
  "UseForwardRate": false,
  "UseInvoiceCustomersVatNumber": false,
  "UsePackageSpecification": null,
  "UseReminder": false,
  "VatRateId": null,
  "VatRate": null,
  "ValidityTimeId": 0,
  "ValidityTime": null,
  "Version": 0,
  "VisitingAddressId": null,
  "VisitingAddress": null,
  "CustomerPartLinks": null,
  "CaseEntries": null,
  "OtherCustomerNumbers": null,
  "CommunicationAddresses": null,
  "ExtraFields": null,
  "PreliminaryPickingList": false,
  "CurrencyExchangeTypeId": 0,
  "RootId": 0,
  "EmployeeSpanId": null,
  "EmployeeSpan": null
}