API

CRM APIs

PUT sales/customers/{customerId}

Saves/stores details about a customer

HTTP method PUT
URI https://api.rambase.net/sales/customers/{customerId}
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {customerId} Customer identifier
Integer, minimum 10000
Custom fields Custom fields supported
Successful HTTP status code 200
API resource identifier 202, version 57

The following body must be added to the request. Mouse over fieldnames for description and other useful information about the fields. Note that fields in bold are required/mandatory.

Format:
1
<Customer
Customer

This field is optional.

>
2
     <Name
Name

Name of customer (name of company or surname/familyname/lastname of a person)

This field is optional.

>
{String}</Name>
3
     <IsCompany
IsCompany

Indicator if a customer is private entity or a company

This field is optional.

>
{Boolean}</IsCompany>
4
     <FirstName
FirstName

Secondary name of a company or firstname of a person

This field is optional.

>
{String}</FirstName>
5
     <PreferredLanguage
PreferredLanguage

Preferred language for the customer. Is used in prints etc.

Applicable domain values can be found here

Input must match the following regular expression pattern: ^[a-z]{3}$

This field is optional.

>
{String}</PreferredLanguage>
6
     <Website
Website

Customers website/homepage/webpage

This field is optional.

>
{String}</Website>
7
     <Phone
Phone

Customers main phone number

This field is optional.

>
{String}</Phone>
8
     <Fax
Fax

Customers main fax number

This field is optional.

>
{String}</Fax>
9
     <Email
Email

Customers main email

Input must match the following regular expression pattern: ^\w+([-+.']\w+)*@\w+([-.]\w+)*\.\w+([-.]\w+)*$

This field is optional.

>
{String}</Email>
10
     <ExternalReference
ExternalReference

External customer reference/identifier. Can be used in external systems.

This field is optional.

>
{String}</ExternalReference>
11
     <InternalNote
InternalNote

Internal note/notice of the customer. Should not be visible to the customer.

This field is optional.

>
{String}</InternalNote>
12
     <IsRelatedBusinessEntity
IsRelatedBusinessEntity

Identify if a customer is related business entity to the company

This field is optional.

>
{Boolean}</IsRelatedBusinessEntity>
13
     <LegalEntityIdentifier
LegalEntityIdentifier

The customers unique enterprise/organization number.

This field is optional.

>
{String}</LegalEntityIdentifier>
14
     <VATRegistrationNumber
VATRegistrationNumber

Unique number assigned by the relevant tax authority to identify a party for use in relation to value added tax (VAT).

This field is optional.

>
{String}</VATRegistrationNumber>
15
     <EORINumber
EORINumber

An EORI (Economic Operator Registration and Identification number) number is required of any party intending to import into the EU or export from the EU.

This field is optional.

>
{String}</EORINumber>
16
     <Classification
Classification

Classification of the customer

Applicable domain values can be found here

This field is optional.

>
{String}</Classification>
17
     <Intercompany
Intercompany

This field is optional.

>
18
          <Code
Code

Intercompany database the customer belongs to.

This field is optional.

>
{String}</Code>
19
     </Intercompany>
20
     <Currencies
Currencies

Currencies used by the customer

This field is optional.

>
21
          <Currency
Currency

This field is optional.

>
22
               <CurrencyCode
CurrencyCode

Three character code following the ISO 4217 standard

Applicable domain values can be found here

This field is optional.

>
{String}</CurrencyCode>
23
          </Currency>
24
     </Currencies>
25
     <Sales
Sales

This field is optional.

>
26
          <SalesDistrict
SalesDistrict

A geographic district for which an individual salesperson or sales team holds responsibility

Applicable domain values can be found here

This field is optional.

>
{String}</SalesDistrict>
27
          <Sector
Sector

The sector the customer belongs to.

Applicable domain values can be found here

This field is optional.

>
{String}</Sector>
28
          <MarketSegment
MarketSegment

Market segment of the customer

Applicable domain values can be found here

This field is optional.

>
{String}</MarketSegment>
29
          <MinimumGrossMargin
MinimumGrossMargin

The minimum gross margin in percent for the customer

Minimum value: 0

Maximum value: 99

This field is optional.

>
{Decimal}</MinimumGrossMargin>
30
          <VATHandling
VATHandling

Specifies how value added tax (VAT) should be calculated. Either always include VAT, always exclude VAT or use standard/default VAT rules.

Applicable domain values can be found here

This field is optional.

>
{String}</VATHandling>
31
          <WarrantyPeriod
WarrantyPeriod

Agreement of default warranty period in months

Minimum value: 0

This field is optional.

>
{Integer}</WarrantyPeriod>
32
          <FeeAmount
FeeAmount

This is an amount, in the companies local currency, that by default will be added as fee when a sales order is created for this customer.

Minimum value: 0

This field is optional.

>
{Decimal}</FeeAmount>
33
          <VolumePriceAgreement
VolumePriceAgreement

Special price agreement related to the quantity beeing ordered.

Applicable domain values can be found here

This field is optional.

>
{String}</VolumePriceAgreement>
34
          <ExchangeRateFluctuationAgreement
ExchangeRateFluctuationAgreement

When a sales order is issued, RamBase stores the current exchange rate and the currency the product normally is purchased in. The exchange rate might have changed when the invoice is issued. The exchange rate fluctuation agreement specifies how to handle these differences. The agreement has the format AAA/BBB, where AAA is a percentage of the total invoice, and BBB is the exchange rate fluctuation percentage. E.g. 100/3.0 means that if the rate of exchange on the date a sales order is forwarded to an invoice has changed more than +/- 3% from the rate of exchange, 100% of the invoice amount will be adjusted.

Applicable domain values can be found here

This field is optional.

>
{String}</ExchangeRateFluctuationAgreement>
35
          <BlockSalesOrderRegistration
BlockSalesOrderRegistration

True if sales orders for this customer should be blocked/denied/rejected registration. A notification of type "Stop" will also be added to sales orders for this customer.

This field is optional.

>
{Boolean}</BlockSalesOrderRegistration>
36
          <BlockSalesQuoteRegistration
BlockSalesQuoteRegistration

True if sales quotes for this customer should be blocked/denied/rejected registration. A notification of type "Stop" will also be added to sales quotes for this customer.

This field is optional.

>
{Boolean}</BlockSalesQuoteRegistration>
37
          <PriceList
PriceList

This field is optional.

>
38
               <PriceListId
PriceListId

Price list identifier

Minimum value: 100000

This field is optional.

>
{Integer}</PriceListId>
39
          </PriceList>
40
          <SalesAssistant
SalesAssistant

Reference to the employee who is sales assistant for the customer.

This field is optional.

>
41
               <EmployeeId
EmployeeId

Employee identifier

Minimum value: 100

This field is optional.

>
{Integer}</EmployeeId>
42
          </SalesAssistant>
43
          <AccountManager
AccountManager

Reference to the employee who is responsible for the management of sales, and relationship with the customer.

This field is optional.

>
44
               <EmployeeId
EmployeeId

Employee identifier

Minimum value: 100

This field is optional.

>
{Integer}</EmployeeId>
45
          </AccountManager>
46
     </Sales>
47
     <Shipment
Shipment

This field is optional.

>
48
          <DeliveryTerms
DeliveryTerms

Default delivery terms for the customer. The delivery terms is based on the Incoterms rules from ICC (International Chamber of Commerce).

Applicable domain values can be found here

This field is optional.

>
{String}</DeliveryTerms>
49
          <DeliveryTermPlace
DeliveryTermPlace

Named place related to delivery terms (Incoterms)

This field is optional.

>
{String}</DeliveryTermPlace>
50
          <OnlyShipEntireSalesOrders
OnlyShipEntireSalesOrders

True if all items of a sales order should be shipped together. The items of a sales order should never be split into several shipments. If sales order is forwarded to shipping advice by bulk handling, this will be controlled by RamBase. Manually forward requires that the users controls this themselves.

This field is optional.

>
{Boolean}</OnlyShipEntireSalesOrders>
51
          <OnlyShipEntireSalesOrderItems
OnlyShipEntireSalesOrderItems

True if the total quantity of a sales order item always should be shipped together. The quantity should never be split into several shipments. If sales order is forwarded to shipping advice by bulk handling, this will be controlled by RamBase. Manually forward requires that the users controls this themselves.

This field is optional.

>
{Boolean}</OnlyShipEntireSalesOrderItems>
52
          <AvoidMultipleShipmentsOnSameDate
AvoidMultipleShipmentsOnSameDate

True if all items of a sales order with the same sheduled delivery date should be shipped together. If sales order is forwarded to shipping advice by bulk handling, this will be controlled by RamBase. Manually forward requires that the users controls this themselves.

This field is optional.

>
{Boolean}</AvoidMultipleShipmentsOnSameDate>
53
          <ShipBasedOnConfirmedDeliveryDate
ShipBasedOnConfirmedDeliveryDate

If true, will sheduled shipping date on each item be calculated based on confirmed date rather than requested date.

This field is optional.

>
{Boolean}</ShipBasedOnConfirmedDeliveryDate>
54
          <FreightForEachShipment
FreightForEachShipment

If unchecked there will only be calculated freight on one shipping advice if the particular sales order has serveral shipments.

This field is optional.

>
{Boolean}</FreightForEachShipment>
55
          <ShippingDay
ShippingDay

Specifies when the goods should be shipped. This is used to calculate the scheduled shipping date for each item.

Applicable domain values can be found here

This field is optional.

>
{String}</ShippingDay>
56
          <ConsolidateShippingAdvices
ConsolidateShippingAdvices

If true, sales orders will be consolidated when creating shipping advices via the "Prepare for picking" process the . If false, each sales order will result in seperate shipping advice. The field to use when consolidating is specified in the ShippingAdviceConsolidationField.

This field is optional.

>
{Boolean}</ConsolidateShippingAdvices>
57
          <ShippingAdviceConsolidationField
ShippingAdviceConsolidationField

Field to use when consolidating sales order items into shipping advices in the "Prepare for picking" process.

Applicable domain values can be found here

This field is optional.

>
{String}</ShippingAdviceConsolidationField>
58
          <ShippingAdviceItemSortBy
ShippingAdviceItemSortBy

Items in consolidated shipping advices will be sorted by this fields when they are created in the 'Prepare for picking' process

Applicable domain values can be found here

This field is optional.

>
{String}</ShippingAdviceItemSortBy>
59
          <RequireApprovalIfOverdue
RequireApprovalIfOverdue

True if shipments need approval if there are sales invoices with overdue amount. Default value is retireved from setting: DefaultCreateValueCUSFieldDUEAPPROVE

This field is optional.

>
{Boolean}</RequireApprovalIfOverdue>
60
          <BlockShipping
BlockShipping

True if shipping advices for this customer should be blocked/denied/rejected registration. A notification of type "Stop" will also be added to shipping advices for this customer.

This field is optional.

>
{Boolean}</BlockShipping>
61
          <SpecialHandling
SpecialHandling

This field is optional.

>
62
               <SpecialHandlingId
SpecialHandlingId

The special handling code used for this customer.

Minimum value: 0

This field is optional.

>
{Integer}</SpecialHandlingId>
63
          </SpecialHandling>
64
          <ShippingService
ShippingService

This field is optional.

>
65
               <ShippingServiceId
ShippingServiceId

Shipping service identifier

Minimum value: 100000

This field is optional.

>
{Integer}</ShippingServiceId>
66
          </ShippingService>
67
     </Shipment>
68
     <Invoicing
Invoicing

This field is optional.

>
69
          <InterestRate
InterestRate

Interest rate used for sales invoices past duedate

Minimum value: 0

Maximum value: 1000

This field is optional.

>
{Decimal}</InterestRate>
70
          <InterestFeeAmount
InterestFeeAmount

Fixed interest fee used for the customer.

Minimum value: 0

This field is optional.

>
{Decimal}</InterestFeeAmount>
71
          <SalesInvoiceConsolidation
SalesInvoiceConsolidation

Specifies whether or how often shipping advices that origins from this sales order will be consolidated when creating sales invoices.

Applicable domain values can be found here

This field is optional.

>
{String}</SalesInvoiceConsolidation>
72
          <SalesInvoiceConsolidationField
SalesInvoiceConsolidationField

Field name to group by when consolidating shipping advice items into sales invoices.

Applicable domain values can be found here

This field is optional.

>
{String}</SalesInvoiceConsolidationField>
73
          <SalesInvoiceItemSortBy
SalesInvoiceItemSortBy

Field name to sort by when creating sales invoice items.

Applicable domain values can be found here

This field is optional.

>
{String}</SalesInvoiceItemSortBy>
74
          <SendReminders
SendReminders

Set to false if reminder are not be sent to this customer. Default value is retireved from setting: DefaultCreateValueCUSFieldREMINDER

This field is optional.

>
{Boolean}</SendReminders>
75
          <SendToFactoring
SendToFactoring

Identify which customer, invoices ands credit notes, will be send to factoring

This field is optional.

>
{Boolean}</SendToFactoring>
76
     </Invoicing>
77
     <Payment
Payment

This field is optional.

>
78
          <PaymentTerms
PaymentTerms

Default payment terms to use in new documents.

Applicable domain values can be found here

This field is optional.

>
{String}</PaymentTerms>
79
          <PaymentMethod
PaymentMethod

Default payment method for the customer

Applicable domain values can be found here

This field is optional.

>
{String}</PaymentMethod>
80
     </Payment>
81
     <Accounting
Accounting

This field is optional.

>
82
          <CreditLimit
CreditLimit

The maximum amount that the customer may charge on a credit card or borrow from a financial institution.

Minimum value: 0

This field is optional.

>
{Decimal}</CreditLimit>
83
          <CreditInsuranceAmount
CreditInsuranceAmount

Credit amount insured for the customer

Minimum value: 0

This field is optional.

>
{Decimal}</CreditInsuranceAmount>
84
          <CreditInsuranceCompany
CreditInsuranceCompany

Insurance company used by the customer for credit insurance

This field is optional.

>
{String}</CreditInsuranceCompany>
85
     </Accounting>
86
     <Auction
Auction

This field is optional.

>
87
          <FeePercent
FeePercent

The commission paid by the customer when purchasing LOTs

Minimum value: 0

Maximum value: 100

This field is optional.

>
{Decimal}</FeePercent>
88
     </Auction>
89
     <Service
Service

This field is optional.

>
90
          <SpecialHandling
SpecialHandling

This field is optional.

>
91
               <SpecialHandlingId
SpecialHandlingId

The special handling code used for service.

Minimum value: 100000

This field is optional.

>
{Integer}</SpecialHandlingId>
92
          </SpecialHandling>
93
     </Service>
94
</Customer>
1
{
2
     "customer
Customer

This field is optional.

":
{
3
          "name
Name

Name of customer (name of company or surname/familyname/lastname of a person)

This field is optional.

":
"{String}",
4
          "isCompany
IsCompany

Indicator if a customer is private entity or a company

This field is optional.

":
"{Boolean}",
5
          "firstName
FirstName

Secondary name of a company or firstname of a person

This field is optional.

":
"{String}",
6
          "preferredLanguage
PreferredLanguage

Preferred language for the customer. Is used in prints etc.

Applicable domain values can be found here

Input must match the following regular expression pattern: ^[a-z]{3}$

This field is optional.

":
"{String}",
7
          "website
Website

Customers website/homepage/webpage

This field is optional.

":
"{String}",
8
          "phone
Phone

Customers main phone number

This field is optional.

":
"{String}",
9
          "fax
Fax

Customers main fax number

This field is optional.

":
"{String}",
10
          "email
Email

Customers main email

Input must match the following regular expression pattern: ^\w+([-+.']\w+)*@\w+([-.]\w+)*\.\w+([-.]\w+)*$

This field is optional.

":
"{String}",
11
          "externalReference
ExternalReference

External customer reference/identifier. Can be used in external systems.

This field is optional.

":
"{String}",
12
          "internalNote
InternalNote

Internal note/notice of the customer. Should not be visible to the customer.

This field is optional.

":
"{String}",
13
          "isRelatedBusinessEntity
IsRelatedBusinessEntity

Identify if a customer is related business entity to the company

This field is optional.

":
"{Boolean}",
14
          "legalEntityIdentifier
LegalEntityIdentifier

The customers unique enterprise/organization number.

This field is optional.

":
"{String}",
15
          "vATRegistrationNumber
VATRegistrationNumber

Unique number assigned by the relevant tax authority to identify a party for use in relation to value added tax (VAT).

This field is optional.

":
"{String}",
16
          "eORINumber
EORINumber

An EORI (Economic Operator Registration and Identification number) number is required of any party intending to import into the EU or export from the EU.

This field is optional.

":
"{String}",
17
          "classification
Classification

Classification of the customer

Applicable domain values can be found here

This field is optional.

":
"{String}",
18
          "intercompany
Intercompany

This field is optional.

":
{
19
               "code
Code

Intercompany database the customer belongs to.

This field is optional.

":
"{String}"
20
          },
21
          "currencies
Currencies

Currencies used by the customer

This field is optional.

":
[
22
               {
23
                    "currencyCode
CurrencyCode

Three character code following the ISO 4217 standard

Applicable domain values can be found here

This field is optional.

":
"{String}"
24
               }
25
          ],
26
          "sales
Sales

This field is optional.

":
{
27
               "salesDistrict
SalesDistrict

A geographic district for which an individual salesperson or sales team holds responsibility

Applicable domain values can be found here

This field is optional.

":
"{String}",
28
               "sector
Sector

The sector the customer belongs to.

Applicable domain values can be found here

This field is optional.

":
"{String}",
29
               "marketSegment
MarketSegment

Market segment of the customer

Applicable domain values can be found here

This field is optional.

":
"{String}",
30
               "minimumGrossMargin
MinimumGrossMargin

The minimum gross margin in percent for the customer

Minimum value: 0

Maximum value: 99

This field is optional.

":
"{Decimal}",
31
               "vATHandling
VATHandling

Specifies how value added tax (VAT) should be calculated. Either always include VAT, always exclude VAT or use standard/default VAT rules.

Applicable domain values can be found here

This field is optional.

":
"{String}",
32
               "warrantyPeriod
WarrantyPeriod

Agreement of default warranty period in months

Minimum value: 0

This field is optional.

":
"{Integer}",
33
               "feeAmount
FeeAmount

This is an amount, in the companies local currency, that by default will be added as fee when a sales order is created for this customer.

Minimum value: 0

This field is optional.

":
"{Decimal}",
34
               "volumePriceAgreement
VolumePriceAgreement

Special price agreement related to the quantity beeing ordered.

Applicable domain values can be found here

This field is optional.

":
"{String}",
35
               "exchangeRateFluctuationAgreement
ExchangeRateFluctuationAgreement

When a sales order is issued, RamBase stores the current exchange rate and the currency the product normally is purchased in. The exchange rate might have changed when the invoice is issued. The exchange rate fluctuation agreement specifies how to handle these differences. The agreement has the format AAA/BBB, where AAA is a percentage of the total invoice, and BBB is the exchange rate fluctuation percentage. E.g. 100/3.0 means that if the rate of exchange on the date a sales order is forwarded to an invoice has changed more than +/- 3% from the rate of exchange, 100% of the invoice amount will be adjusted.

Applicable domain values can be found here

This field is optional.

":
"{String}",
36
               "blockSalesOrderRegistration
BlockSalesOrderRegistration

True if sales orders for this customer should be blocked/denied/rejected registration. A notification of type "Stop" will also be added to sales orders for this customer.

This field is optional.

":
"{Boolean}",
37
               "blockSalesQuoteRegistration
BlockSalesQuoteRegistration

True if sales quotes for this customer should be blocked/denied/rejected registration. A notification of type "Stop" will also be added to sales quotes for this customer.

This field is optional.

":
"{Boolean}",
38
               "priceList
PriceList

This field is optional.

":
{
39
                    "priceListId
PriceListId

Price list identifier

Minimum value: 100000

This field is optional.

":
"{Integer}"
40
               },
41
               "salesAssistant
SalesAssistant

Reference to the employee who is sales assistant for the customer.

This field is optional.

":
{
42
                    "employeeId
EmployeeId

Employee identifier

Minimum value: 100

This field is optional.

":
"{Integer}"
43
               },
44
               "accountManager
AccountManager

Reference to the employee who is responsible for the management of sales, and relationship with the customer.

This field is optional.

":
{
45
                    "employeeId
EmployeeId

Employee identifier

Minimum value: 100

This field is optional.

":
"{Integer}"
46
               }
47
          },
48
          "shipment
Shipment

This field is optional.

":
{
49
               "deliveryTerms
DeliveryTerms

Default delivery terms for the customer. The delivery terms is based on the Incoterms rules from ICC (International Chamber of Commerce).

Applicable domain values can be found here

This field is optional.

":
"{String}",
50
               "deliveryTermPlace
DeliveryTermPlace

Named place related to delivery terms (Incoterms)

This field is optional.

":
"{String}",
51
               "onlyShipEntireSalesOrders
OnlyShipEntireSalesOrders

True if all items of a sales order should be shipped together. The items of a sales order should never be split into several shipments. If sales order is forwarded to shipping advice by bulk handling, this will be controlled by RamBase. Manually forward requires that the users controls this themselves.

This field is optional.

":
"{Boolean}",
52
               "onlyShipEntireSalesOrderItems
OnlyShipEntireSalesOrderItems

True if the total quantity of a sales order item always should be shipped together. The quantity should never be split into several shipments. If sales order is forwarded to shipping advice by bulk handling, this will be controlled by RamBase. Manually forward requires that the users controls this themselves.

This field is optional.

":
"{Boolean}",
53
               "avoidMultipleShipmentsOnSameDate
AvoidMultipleShipmentsOnSameDate

True if all items of a sales order with the same sheduled delivery date should be shipped together. If sales order is forwarded to shipping advice by bulk handling, this will be controlled by RamBase. Manually forward requires that the users controls this themselves.

This field is optional.

":
"{Boolean}",
54
               "shipBasedOnConfirmedDeliveryDate
ShipBasedOnConfirmedDeliveryDate

If true, will sheduled shipping date on each item be calculated based on confirmed date rather than requested date.

This field is optional.

":
"{Boolean}",
55
               "freightForEachShipment
FreightForEachShipment

If unchecked there will only be calculated freight on one shipping advice if the particular sales order has serveral shipments.

This field is optional.

":
"{Boolean}",
56
               "shippingDay
ShippingDay

Specifies when the goods should be shipped. This is used to calculate the scheduled shipping date for each item.

Applicable domain values can be found here

This field is optional.

":
"{String}",
57
               "consolidateShippingAdvices
ConsolidateShippingAdvices

If true, sales orders will be consolidated when creating shipping advices via the "Prepare for picking" process the . If false, each sales order will result in seperate shipping advice. The field to use when consolidating is specified in the ShippingAdviceConsolidationField.

This field is optional.

":
"{Boolean}",
58
               "shippingAdviceConsolidationField
ShippingAdviceConsolidationField

Field to use when consolidating sales order items into shipping advices in the "Prepare for picking" process.

Applicable domain values can be found here

This field is optional.

":
"{String}",
59
               "shippingAdviceItemSortBy
ShippingAdviceItemSortBy

Items in consolidated shipping advices will be sorted by this fields when they are created in the 'Prepare for picking' process

Applicable domain values can be found here

This field is optional.

":
"{String}",
60
               "requireApprovalIfOverdue
RequireApprovalIfOverdue

True if shipments need approval if there are sales invoices with overdue amount. Default value is retireved from setting: DefaultCreateValueCUSFieldDUEAPPROVE

This field is optional.

":
"{Boolean}",
61
               "blockShipping
BlockShipping

True if shipping advices for this customer should be blocked/denied/rejected registration. A notification of type "Stop" will also be added to shipping advices for this customer.

This field is optional.

":
"{Boolean}",
62
               "specialHandling
SpecialHandling

This field is optional.

":
{
63
                    "specialHandlingId
SpecialHandlingId

The special handling code used for this customer.

Minimum value: 0

This field is optional.

":
"{Integer}"
64
               },
65
               "shippingService
ShippingService

This field is optional.

":
{
66
                    "shippingServiceId
ShippingServiceId

Shipping service identifier

Minimum value: 100000

This field is optional.

":
"{Integer}"
67
               }
68
          },
69
          "invoicing
Invoicing

This field is optional.

":
{
70
               "interestRate
InterestRate

Interest rate used for sales invoices past duedate

Minimum value: 0

Maximum value: 1000

This field is optional.

":
"{Decimal}",
71
               "interestFeeAmount
InterestFeeAmount

Fixed interest fee used for the customer.

Minimum value: 0

This field is optional.

":
"{Decimal}",
72
               "salesInvoiceConsolidation
SalesInvoiceConsolidation

Specifies whether or how often shipping advices that origins from this sales order will be consolidated when creating sales invoices.

Applicable domain values can be found here

This field is optional.

":
"{String}",
73
               "salesInvoiceConsolidationField
SalesInvoiceConsolidationField

Field name to group by when consolidating shipping advice items into sales invoices.

Applicable domain values can be found here

This field is optional.

":
"{String}",
74
               "salesInvoiceItemSortBy
SalesInvoiceItemSortBy

Field name to sort by when creating sales invoice items.

Applicable domain values can be found here

This field is optional.

":
"{String}",
75
               "sendReminders
SendReminders

Set to false if reminder are not be sent to this customer. Default value is retireved from setting: DefaultCreateValueCUSFieldREMINDER

This field is optional.

":
"{Boolean}",
76
               "sendToFactoring
SendToFactoring

Identify which customer, invoices ands credit notes, will be send to factoring

This field is optional.

":
"{Boolean}"
77
          },
78
          "payment
Payment

This field is optional.

":
{
79
               "paymentTerms
PaymentTerms

Default payment terms to use in new documents.

Applicable domain values can be found here

This field is optional.

":
"{String}",
80
               "paymentMethod
PaymentMethod

Default payment method for the customer

Applicable domain values can be found here

This field is optional.

":
"{String}"
81
          },
82
          "accounting
Accounting

This field is optional.

":
{
83
               "creditLimit
CreditLimit

The maximum amount that the customer may charge on a credit card or borrow from a financial institution.

Minimum value: 0

This field is optional.

":
"{Decimal}",
84
               "creditInsuranceAmount
CreditInsuranceAmount

Credit amount insured for the customer

Minimum value: 0

This field is optional.

":
"{Decimal}",
85
               "creditInsuranceCompany
CreditInsuranceCompany

Insurance company used by the customer for credit insurance

This field is optional.

":
"{String}"
86
          },
87
          "auction
Auction

This field is optional.

":
{
88
               "feePercent
FeePercent

The commission paid by the customer when purchasing LOTs

Minimum value: 0

Maximum value: 100

This field is optional.

":
"{Decimal}"
89
          },
90
          "service
Service

This field is optional.

":
{
91
               "specialHandling
SpecialHandling

This field is optional.

":
{
92
                    "specialHandlingId
SpecialHandlingId

The special handling code used for service.

Minimum value: 100000

This field is optional.

":
"{Integer}"
93
               }
94
          }
95
     }
96
}

The query string is placed after the resource URL, seperated with a questionmark (?). The query string is composed of a series of query parameters with values. See the page about query parameters on how to use these parameters.

$access_token String, optional After successful login you get an access token which needs to be provided in all API requests. Even though it is possible to pass this token as query parameter, we recommended passing it using the HTTP request header as described in Authorization. Note that all access tokens have an expiration time.
$db String, optional Set the database/company for the request
$useMinimumVersion Integer, optional Used to run a new version of an API resource when your API client is running a deprecated API resource. See the Breaking changes page for more information.
$showCustomFields Boolean, optional Set to "true" to include custom fields. Default value is false.

Read more about filters and sorting on how to use filter parameters and named filters.

Read more about filters and sorting on how to use sortable parameters

Requesting this resource will yield the following response. Mouse over fieldnames (or fieldgroups) for descriptions and other useful information about the fields. Fields colored in grey is expandable fields.

Please note that some fields may be removed from the response, based on user roles/duties/permissions.

Format:
1
1

List of available operations/actions for this resource.
See the operations documentation for more information about API operations.

Possible error codes the response might return:

Error 101015 HTTP 404 Permission not found
Error 101086 HTTP 400 Missing required argument {0} for description
Error 101087 HTTP 400 Description argument/result mismatch
Error 101399 HTTP 400 Customer account in shipping service mismatch with this customer account
Error 101385 HTTP 400 The carrier that offers this shipping service is not activ (status 4)
Error 100936 HTTP 400 Default invoice- and shipping address is required
Error 100944 HTTP 400 Mismatch between post code and city
Error 100038 HTTP 400 Invalid language: {0}
Error 100200 HTTP 404 Special handling code not found
Error 102751 HTTP 400 Selected pricelist is not active
Error 102939 HTTP 400 Customer can not be blocked for orders before active bids are deleted