API

RamBase REST APIs

GET sales/customers/{customerId}

Customer details for the provided identifier

HTTP method GET
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 156, version 96

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
1

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.

$showDomainDescriptions Boolean, optional Set to "true" to include domain descriptions for fields using domain values. See the Domain values page for more information. Default value is false.
$lang String, optional Specifies the language used in the response, following the 3-letter ISO-639-1 [lll]
$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
$format String, optional Set the format of the response to use for the request. Accepted values are "xml", "html", "jsonstream", "json"
$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.
$select String, optional Use to define the fields to return in the response. Accepts a comma-separated list of field names. See the Expand and select page for more information.
$expand String, optional Use to include output fields that are not returned by default in the response. Accepts a comma-separated list of expandable field names. See the Expand and Select 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
<Customer>
2
     <CustomerId
CustomerId

Customer identifier

>{Integer}</CustomerId>
3
     <Status
Status

Status of the customer. 1:New, 2:Pending internal approvement, 4:Active, 9:Obsolete

Possible domain values can be found here

>{Integer}</Status>
4
     <Name
Name

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

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

Indicator if a customer is private entity or a company

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

Secondary name of a company or firstname of a person

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

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

Possible domain values can be found here

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

Customers website/homepage/webpage

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

Customers main phone number

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

Customers main fax number

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

Customers main email

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

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

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

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

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

Identify if a customer is related business entity to the company

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

The customers unique enterprise/organization number.

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

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

>{String}</VATRegistrationNumber>
17
     <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.

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

Classification of the customer

Possible domain values can be found here

>{String}</Classification>
19
     <UpdatedAt
UpdatedAt

Date and time of update

>{Datetime}</UpdatedAt>
20
     <CreatedAt
CreatedAt

Date and time of creation

>{Datetime}</CreatedAt>
21
     <CreatedBy
CreatedBy

The employee (might be RamBase-server) that created the customer

>
22
          <UserId
UserId

User identifier

>{Integer}</UserId>
23
          <Name
Name

Name of the user

>{String}</Name>
24
          <FirstName
FirstName

First name of the user

>{String}</FirstName>
25
          <UserLink
UserLink

User reference

>{String}</UserLink>
26
     </CreatedBy>
27
     <Intercompany>
28
          <Code
Code

Intercompany database the customer belongs to.

>{String}</Code>
29
     </Intercompany>
30
     <Currencies
Currencies

Currencies used by the customer

>
31
          <Currency>
32
               <CurrencyCode
CurrencyCode

Three character code following the ISO 4217 standard

Possible domain values can be found here

>{String}</CurrencyCode>
33
          </Currency>
34
     </Currencies>
35
     <Sales>
36
          <Currency
Currency

Three character code following the ISO 4217 standard

>{String}</Currency>
37
          <BacklogAmount
BacklogAmount

Total amount of sales orders, excluding value added tax, that not yet has been fulfilled.

>{Decimal}</BacklogAmount>
38
          <BacklogAmountIncludingVAT
BacklogAmountIncludingVAT

Total amount of sales orders, including value added tax, that not yet has been fulfilled

>{Decimal}</BacklogAmountIncludingVAT>
39
          <SalesDistrict
SalesDistrict

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

Possible domain values can be found here

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

The sector the customer belongs to.

Possible domain values can be found here

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

Market segment of the customer

Possible domain values can be found here

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

The minimum gross margin in percent for the customer

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

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

Possible domain values can be found here

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

Agreement of default warranty period in months

>{Integer}</WarrantyPeriod>
45
          <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.

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

Special price agreement related to the quantity beeing ordered.

Possible domain values can be found here

>{String}</VolumePriceAgreement>
47
          <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.

Possible domain values can be found here

>{String}</ExchangeRateFluctuationAgreement>
48
          <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.

>{Boolean}</BlockSalesOrderRegistration>
49
          <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.

>{Boolean}</BlockSalesQuoteRegistration>
50
          <LatestSalesOrderDate
LatestSalesOrderDate

Date of latest sales order or sales order request registration.

>{Date}</LatestSalesOrderDate>
51
          <PriceList>
52
               <PriceListId
PriceListId

Price list identifier

>{Integer}</PriceListId>
53
               <Name
Name

Name of the price list

>{String}</Name>
54
               <PriceListLink
PriceListLink

Price list reference

>{String}</PriceListLink>
55
          </PriceList>
56
          <SalesAssistant
SalesAssistant

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

>
57
               <EmployeeId
EmployeeId

Employee identifier

>{Integer}</EmployeeId>
58
               <LastName
LastName

Last name of employee

>{String}</LastName>
59
               <FirstName
FirstName

First name of employee

>{String}</FirstName>
60
               <EmployeeLink
EmployeeLink

Employee reference

>{String}</EmployeeLink>
61
          </SalesAssistant>
62
          <AccountManager
AccountManager

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

>
63
               <EmployeeId
EmployeeId

Employee identifier

>{Integer}</EmployeeId>
64
               <LastName
LastName

Last name of employee

>{String}</LastName>
65
               <FirstName
FirstName

First name of employee

>{String}</FirstName>
66
               <EmployeeLink
EmployeeLink

Employee reference

>{String}</EmployeeLink>
67
          </AccountManager>
68
     </Sales>
69
     <CustomerLegalEntity
CustomerLegalEntity

This field is greyed out because it is an expandable field. You have to add $expand=CustomerLegalEntity in your request URI to get this field

>
70
          <CustomerLegalEntityId
CustomerLegalEntityId

Customer legal entity identifier

This field is greyed out because it is an expandable field. You have to add $expand=CustomerLegalEntity in your request URI to get this field

>{Integer}</CustomerLegalEntityId>
71
          <CustomerLegalEntityLink
CustomerLegalEntityLink

Reference to customer legal entity

This field is greyed out because it is an expandable field. You have to add $expand=CustomerLegalEntity in your request URI to get this field

>{String}</CustomerLegalEntityLink>
72
     </CustomerLegalEntity>
73
     <Shipment>
74
          <DeliveryTerms
DeliveryTerms

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

Possible domain values can be found here

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

Named place related to delivery terms (Incoterms)

>{String}</DeliveryTermPlace>
76
          <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.

>{Boolean}</OnlyShipEntireSalesOrders>
77
          <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.

>{Boolean}</OnlyShipEntireSalesOrderItems>
78
          <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.

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

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

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

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

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

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

Possible domain values can be found here

>{String}</ShippingDay>
82
          <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.

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

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

Possible domain values can be found here

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

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

Possible domain values can be found here

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

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

>{Boolean}</RequireApprovalIfOverdue>
86
          <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.

>{Boolean}</BlockShipping>
87
          <SpecialHandling>
88
               <SpecialHandlingId
SpecialHandlingId

The special handling code used for this customer.

>{Integer}</SpecialHandlingId>
89
               <SpecialHandlingLink
SpecialHandlingLink

The special handling code used for this customer.

>{String}</SpecialHandlingLink>
90
          </SpecialHandling>
91
          <ShippingService>
92
               <ShippingServiceId
ShippingServiceId

Shipping service identifier

>{Integer}</ShippingServiceId>
93
               <Name
Name

Name of shipping service

>{String}</Name>
94
               <Carrier
Carrier

This field is greyed out because it is an expandable field. You have to add $expand=Shipment.ShippingService.Carrier in your request URI to get this field

>
95
                    <CarrierId
CarrierId

Carrier identifier

This field is greyed out because it is an expandable field. You have to add $expand=Shipment.ShippingService.Carrier in your request URI to get this field

>{Integer}</CarrierId>
96
                    <Name
Name

Name of carrier

This field is greyed out because it is an expandable field. You have to add $expand=Shipment.ShippingService.Carrier in your request URI to get this field

>{String}</Name>
97
                    <CarrierLink
CarrierLink

Carrier reference

This field is greyed out because it is an expandable field. You have to add $expand=Shipment.ShippingService.Carrier in your request URI to get this field

>{String}</CarrierLink>
98
               </Carrier>
99
               <ShippingServiceLink
ShippingServiceLink

Shipping service reference

>{String}</ShippingServiceLink>
100
          </ShippingService>
101
          <DefaultShippingAddress
DefaultShippingAddress

This field is greyed out because it is an expandable field. You have to add $expand=Shipment.DefaultShippingAddress in your request URI to get this field

>
102
               <AddressId
AddressId

Address identifier

This field is greyed out because it is an expandable field. You have to add $expand=Shipment.DefaultShippingAddress in your request URI to get this field

>{Integer}</AddressId>
103
               <Attention
Attention

Attention note.

This field is greyed out because it is an expandable field. You have to add $expand=Shipment.DefaultShippingAddress in your request URI to get this field

>{String}</Attention>
104
               <AddressLine1
AddressLine1

First address line

This field is greyed out because it is an expandable field. You have to add $expand=Shipment.DefaultShippingAddress in your request URI to get this field

>{String}</AddressLine1>
105
               <AddressLine2
AddressLine2

Second address line

This field is greyed out because it is an expandable field. You have to add $expand=Shipment.DefaultShippingAddress in your request URI to get this field

>{String}</AddressLine2>
106
               <PostalCode
PostalCode

Postalcode/Postcode/ZIP

This field is greyed out because it is an expandable field. You have to add $expand=Shipment.DefaultShippingAddress in your request URI to get this field

>{String}</PostalCode>
107
               <City
City

City/town/village

This field is greyed out because it is an expandable field. You have to add $expand=Shipment.DefaultShippingAddress in your request URI to get this field

>{String}</City>
108
               <Region
Region

Region/province/state

This field is greyed out because it is an expandable field. You have to add $expand=Shipment.DefaultShippingAddress in your request URI to get this field

>{String}</Region>
109
               <CountryCode
CountryCode

Two-character code (ISO 3166) identifying the country.

This field is greyed out because it is an expandable field. You have to add $expand=Shipment.DefaultShippingAddress in your request URI to get this field

>{String}</CountryCode>
110
               <Country
Country

English name of country.

This field is greyed out because it is an expandable field. You have to add $expand=Shipment.DefaultShippingAddress in your request URI to get this field

>{String}</Country>
111
               <AddressLink
AddressLink

Address reference

This field is greyed out because it is an expandable field. You have to add $expand=Shipment.DefaultShippingAddress in your request URI to get this field

>{String}</AddressLink>
112
          </DefaultShippingAddress>
113
     </Shipment>
114
     <Invoicing>
115
          <Currency
Currency

Three character code following the ISO 4217 standard

>{String}</Currency>
116
          <InterestRate
InterestRate

Interest rate used for sales invoices past duedate

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

Fixed interest fee used for the customer.

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

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

Possible domain values can be found here

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

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

Possible domain values can be found here

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

Field name to sort by when creating sales invoice items.

Possible domain values can be found here

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

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

>{Boolean}</SendReminders>
122
          <LatestSalesInvoiceDate
LatestSalesInvoiceDate

Date last sales invoice was registered.

>{Date}</LatestSalesInvoiceDate>
123
          <SendToFactoring
SendToFactoring

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

>{Boolean}</SendToFactoring>
124
          <DefaultInvoiceAddress
DefaultInvoiceAddress

This field is greyed out because it is an expandable field. You have to add $expand=Invoicing.DefaultInvoiceAddress in your request URI to get this field

>
125
               <AddressId
AddressId

Address identifier

This field is greyed out because it is an expandable field. You have to add $expand=Invoicing.DefaultInvoiceAddress in your request URI to get this field

>{Integer}</AddressId>
126
               <Attention
Attention

Attention note.

This field is greyed out because it is an expandable field. You have to add $expand=Invoicing.DefaultInvoiceAddress in your request URI to get this field

>{String}</Attention>
127
               <AddressLine1
AddressLine1

First address line

This field is greyed out because it is an expandable field. You have to add $expand=Invoicing.DefaultInvoiceAddress in your request URI to get this field

>{String}</AddressLine1>
128
               <AddressLine2
AddressLine2

Second address line

This field is greyed out because it is an expandable field. You have to add $expand=Invoicing.DefaultInvoiceAddress in your request URI to get this field

>{String}</AddressLine2>
129
               <PostalCode
PostalCode

Postalcode/Postcode/ZIP

This field is greyed out because it is an expandable field. You have to add $expand=Invoicing.DefaultInvoiceAddress in your request URI to get this field

>{String}</PostalCode>
130
               <City
City

City/town/village

This field is greyed out because it is an expandable field. You have to add $expand=Invoicing.DefaultInvoiceAddress in your request URI to get this field

>{String}</City>
131
               <Region
Region

Region/province/state

This field is greyed out because it is an expandable field. You have to add $expand=Invoicing.DefaultInvoiceAddress in your request URI to get this field

>{String}</Region>
132
               <CountryCode
CountryCode

Two-character code (ISO 3166) identifying the country.

This field is greyed out because it is an expandable field. You have to add $expand=Invoicing.DefaultInvoiceAddress in your request URI to get this field

>{String}</CountryCode>
133
               <Country
Country

English name of country.

This field is greyed out because it is an expandable field. You have to add $expand=Invoicing.DefaultInvoiceAddress in your request URI to get this field

>{String}</Country>
134
               <AddressLink
AddressLink

Address reference

This field is greyed out because it is an expandable field. You have to add $expand=Invoicing.DefaultInvoiceAddress in your request URI to get this field

>{String}</AddressLink>
135
          </DefaultInvoiceAddress>
136
     </Invoicing>
137
     <Payment>
138
          <PaymentTerms
PaymentTerms

Default payment terms to use in new documents.

Possible domain values can be found here

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

Default payment method for the customer

Possible domain values can be found here

>{String}</PaymentMethod>
140
          <LatestPaymentDate
LatestPaymentDate

Date last payment was registered

>{Date}</LatestPaymentDate>
141
     </Payment>
142
     <Accounting>
143
          <Currency
Currency

Three character code following the ISO 4217 standard

>{String}</Currency>
144
          <Balance
Balance

Total balance for the customer, without value added tax

>{Decimal}</Balance>
145
          <BalanceIncludingVAT
BalanceIncludingVAT

Total balance for the customer. Positive amount indicates how much the customer owes. Negative amount indicates that the customer has a credit balance.

>{Decimal}</BalanceIncludingVAT>
146
          <BillingYTDAmount
BillingYTDAmount

Total amount of invoices and credit notes that has been invoiced this year (to current date)

>{Decimal}</BillingYTDAmount>
147
          <OverdueAmount
OverdueAmount

Total amount of unpaid invoices which has passed due date

>{Decimal}</OverdueAmount>
148
          <CreditLimit
CreditLimit

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

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

Credit amount insured for the customer

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

Insurance company used by the customer for credit insurance

>{String}</CreditInsuranceCompany>
151
     </Accounting>
152
     <Auction
Auction

This field is greyed out because it is an expandable field. You have to add $expand=Auction in your request URI to get this field

>
153
          <FeePercent
FeePercent

The commission paid by the customer when purchasing LOTs

This field is greyed out because it is an expandable field. You have to add $expand=Auction in your request URI to get this field

>{Decimal}</FeePercent>
154
          <LatestBidDate
LatestBidDate

Last date the customer placed a bid.

This field is greyed out because it is an expandable field. You have to add $expand=Auction in your request URI to get this field

>{Date}</LatestBidDate>
155
          <CrossReference
CrossReference

This field is greyed out because it is an expandable field. You have to add $expand=Auction in your request URI to get this field

>
156
               <Supplier
Supplier

Every customer in auction companies has a cross-reference to a supplier.

This field is greyed out because it is an expandable field. You have to add $expand=Auction in your request URI to get this field

>
157
                    <SupplierId
SupplierId

RamBase supplier identifier

This field is greyed out because it is an expandable field. You have to add $expand=Auction in your request URI to get this field

>{Integer}</SupplierId>
158
                    <SupplierLink
SupplierLink

Supplier reference

This field is greyed out because it is an expandable field. You have to add $expand=Auction in your request URI to get this field

>{String}</SupplierLink>
159
               </Supplier>
160
               <TotalBalance
TotalBalance

Sum of customer and cross referenced supplier balances

This field is greyed out because it is an expandable field. You have to add $expand=Auction in your request URI to get this field

>{Decimal}</TotalBalance>
161
               <TotalOverdueAmount
TotalOverdueAmount

Sum of customer and cross referenced supplier overdued amounts

This field is greyed out because it is an expandable field. You have to add $expand=Auction in your request URI to get this field

>{Decimal}</TotalOverdueAmount>
162
          </CrossReference>
163
     </Auction>
164
     <Service
Service

This field is greyed out because it is an expandable field. You have to add $expand=Service in your request URI to get this field

>
165
          <SpecialHandling
SpecialHandling

This field is greyed out because it is an expandable field. You have to add $expand=Service in your request URI to get this field

>
166
               <SpecialHandlingId
SpecialHandlingId

The special handling code used for service.

This field is greyed out because it is an expandable field. You have to add $expand=Service in your request URI to get this field

>{Integer}</SpecialHandlingId>
167
               <SpecialHandlingLink
SpecialHandlingLink

The special handling code used for service.

This field is greyed out because it is an expandable field. You have to add $expand=Service in your request URI to get this field

>{String}</SpecialHandlingLink>
168
          </SpecialHandling>
169
     </Service>
170
</Customer>
1
{
2
     "customer": {
3
          "customerId
CustomerId

Customer identifier

": "{Integer}",
4
          "status
Status

Status of the customer. 1:New, 2:Pending internal approvement, 4:Active, 9:Obsolete

Possible domain values can be found here

": "{Integer}",
5
          "name
Name

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

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

Indicator if a customer is private entity or a company

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

Secondary name of a company or firstname of a person

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

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

Possible domain values can be found here

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

Customers website/homepage/webpage

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

Customers main phone number

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

Customers main fax number

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

Customers main email

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

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

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

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

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

Identify if a customer is related business entity to the company

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

The customers unique enterprise/organization number.

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

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

": "{String}",
18
          "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.

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

Classification of the customer

Possible domain values can be found here

": "{String}",
20
          "updatedAt
UpdatedAt

Date and time of update

": "{Datetime}",
21
          "createdAt
CreatedAt

Date and time of creation

": "{Datetime}",
22
          "createdBy
CreatedBy

The employee (might be RamBase-server) that created the customer

": {
23
               "userId
UserId

User identifier

": "{Integer}",
24
               "name
Name

Name of the user

": "{String}",
25
               "firstName
FirstName

First name of the user

": "{String}",
26
               "userLink
UserLink

User reference

": "{String}"
27
          },
28
          "intercompany": {
29
               "code
Code

Intercompany database the customer belongs to.

": "{String}"
30
          },
31
          "currencies
Currencies

Currencies used by the customer

": [
32
               {
33
                    "currencyCode
CurrencyCode

Three character code following the ISO 4217 standard

Possible domain values can be found here

": "{String}"
34
               }
35
          ],
36
          "sales": {
37
               "currency
Currency

Three character code following the ISO 4217 standard

": "{String}",
38
               "backlogAmount
BacklogAmount

Total amount of sales orders, excluding value added tax, that not yet has been fulfilled.

": "{Decimal}",
39
               "backlogAmountIncludingVAT
BacklogAmountIncludingVAT

Total amount of sales orders, including value added tax, that not yet has been fulfilled

": "{Decimal}",
40
               "salesDistrict
SalesDistrict

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

Possible domain values can be found here

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

The sector the customer belongs to.

Possible domain values can be found here

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

Market segment of the customer

Possible domain values can be found here

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

The minimum gross margin in percent for the customer

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

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

Possible domain values can be found here

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

Agreement of default warranty period in months

": "{Integer}",
46
               "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.

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

Special price agreement related to the quantity beeing ordered.

Possible domain values can be found here

": "{String}",
48
               "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.

Possible domain values can be found here

": "{String}",
49
               "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.

": "{Boolean}",
50
               "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.

": "{Boolean}",
51
               "latestSalesOrderDate
LatestSalesOrderDate

Date of latest sales order or sales order request registration.

": "{Date}",
52
               "priceList": {
53
                    "priceListId
PriceListId

Price list identifier

": "{Integer}",
54
                    "name
Name

Name of the price list

": "{String}",
55
                    "priceListLink
PriceListLink

Price list reference

": "{String}"
56
               },
57
               "salesAssistant
SalesAssistant

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

": {
58
                    "employeeId
EmployeeId

Employee identifier

": "{Integer}",
59
                    "lastName
LastName

Last name of employee

": "{String}",
60
                    "firstName
FirstName

First name of employee

": "{String}",
61
                    "employeeLink
EmployeeLink

Employee reference

": "{String}"
62
               },
63
               "accountManager
AccountManager

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

": {
64
                    "employeeId
EmployeeId

Employee identifier

": "{Integer}",
65
                    "lastName
LastName

Last name of employee

": "{String}",
66
                    "firstName
FirstName

First name of employee

": "{String}",
67
                    "employeeLink
EmployeeLink

Employee reference

": "{String}"
68
               }
69
          },
70
          "customerLegalEntity
CustomerLegalEntity

This field is greyed out because it is an expandable field. You have to add $expand=CustomerLegalEntity in your request URI to get this field

": {
71
               "customerLegalEntityId
CustomerLegalEntityId

Customer legal entity identifier

This field is greyed out because it is an expandable field. You have to add $expand=CustomerLegalEntity in your request URI to get this field

": "{Integer}",
72
               "customerLegalEntityLink
CustomerLegalEntityLink

Reference to customer legal entity

This field is greyed out because it is an expandable field. You have to add $expand=CustomerLegalEntity in your request URI to get this field

": "{String}"
73
          },
74
          "shipment": {
75
               "deliveryTerms
DeliveryTerms

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

Possible domain values can be found here

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

Named place related to delivery terms (Incoterms)

": "{String}",
77
               "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.

": "{Boolean}",
78
               "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.

": "{Boolean}",
79
               "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.

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

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

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

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

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

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

Possible domain values can be found here

": "{String}",
83
               "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.

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

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

Possible domain values can be found here

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

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

Possible domain values can be found here

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

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

": "{Boolean}",
87
               "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.

": "{Boolean}",
88
               "specialHandling": {
89
                    "specialHandlingId
SpecialHandlingId

The special handling code used for this customer.

": "{Integer}",
90
                    "specialHandlingLink
SpecialHandlingLink

The special handling code used for this customer.

": "{String}"
91
               },
92
               "shippingService": {
93
                    "shippingServiceId
ShippingServiceId

Shipping service identifier

": "{Integer}",
94
                    "name
Name

Name of shipping service

": "{String}",
95
                    "carrier
Carrier

This field is greyed out because it is an expandable field. You have to add $expand=Shipment.ShippingService.Carrier in your request URI to get this field

": {
96
                         "carrierId
CarrierId

Carrier identifier

This field is greyed out because it is an expandable field. You have to add $expand=Shipment.ShippingService.Carrier in your request URI to get this field

": "{Integer}",
97
                         "name
Name

Name of carrier

This field is greyed out because it is an expandable field. You have to add $expand=Shipment.ShippingService.Carrier in your request URI to get this field

": "{String}",
98
                         "carrierLink
CarrierLink

Carrier reference

This field is greyed out because it is an expandable field. You have to add $expand=Shipment.ShippingService.Carrier in your request URI to get this field

": "{String}"
99
                    },
100
                    "shippingServiceLink
ShippingServiceLink

Shipping service reference

": "{String}"
101
               },
102
               "defaultShippingAddress
DefaultShippingAddress

This field is greyed out because it is an expandable field. You have to add $expand=Shipment.DefaultShippingAddress in your request URI to get this field

": {
103
                    "addressId
AddressId

Address identifier

This field is greyed out because it is an expandable field. You have to add $expand=Shipment.DefaultShippingAddress in your request URI to get this field

": "{Integer}",
104
                    "attention
Attention

Attention note.

This field is greyed out because it is an expandable field. You have to add $expand=Shipment.DefaultShippingAddress in your request URI to get this field

": "{String}",
105
                    "addressLine1
AddressLine1

First address line

This field is greyed out because it is an expandable field. You have to add $expand=Shipment.DefaultShippingAddress in your request URI to get this field

": "{String}",
106
                    "addressLine2
AddressLine2

Second address line

This field is greyed out because it is an expandable field. You have to add $expand=Shipment.DefaultShippingAddress in your request URI to get this field

": "{String}",
107
                    "postalCode
PostalCode

Postalcode/Postcode/ZIP

This field is greyed out because it is an expandable field. You have to add $expand=Shipment.DefaultShippingAddress in your request URI to get this field

": "{String}",
108
                    "city
City

City/town/village

This field is greyed out because it is an expandable field. You have to add $expand=Shipment.DefaultShippingAddress in your request URI to get this field

": "{String}",
109
                    "region
Region

Region/province/state

This field is greyed out because it is an expandable field. You have to add $expand=Shipment.DefaultShippingAddress in your request URI to get this field

": "{String}",
110
                    "countryCode
CountryCode

Two-character code (ISO 3166) identifying the country.

This field is greyed out because it is an expandable field. You have to add $expand=Shipment.DefaultShippingAddress in your request URI to get this field

": "{String}",
111
                    "country
Country

English name of country.

This field is greyed out because it is an expandable field. You have to add $expand=Shipment.DefaultShippingAddress in your request URI to get this field

": "{String}",
112
                    "addressLink
AddressLink

Address reference

This field is greyed out because it is an expandable field. You have to add $expand=Shipment.DefaultShippingAddress in your request URI to get this field

": "{String}"
113
               }
114
          },
115
          "invoicing": {
116
               "currency
Currency

Three character code following the ISO 4217 standard

": "{String}",
117
               "interestRate
InterestRate

Interest rate used for sales invoices past duedate

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

Fixed interest fee used for the customer.

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

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

Possible domain values can be found here

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

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

Possible domain values can be found here

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

Field name to sort by when creating sales invoice items.

Possible domain values can be found here

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

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

": "{Boolean}",
123
               "latestSalesInvoiceDate
LatestSalesInvoiceDate

Date last sales invoice was registered.

": "{Date}",
124
               "sendToFactoring
SendToFactoring

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

": "{Boolean}",
125
               "defaultInvoiceAddress
DefaultInvoiceAddress

This field is greyed out because it is an expandable field. You have to add $expand=Invoicing.DefaultInvoiceAddress in your request URI to get this field

": {
126
                    "addressId
AddressId

Address identifier

This field is greyed out because it is an expandable field. You have to add $expand=Invoicing.DefaultInvoiceAddress in your request URI to get this field

": "{Integer}",
127
                    "attention
Attention

Attention note.

This field is greyed out because it is an expandable field. You have to add $expand=Invoicing.DefaultInvoiceAddress in your request URI to get this field

": "{String}",
128
                    "addressLine1
AddressLine1

First address line

This field is greyed out because it is an expandable field. You have to add $expand=Invoicing.DefaultInvoiceAddress in your request URI to get this field

": "{String}",
129
                    "addressLine2
AddressLine2

Second address line

This field is greyed out because it is an expandable field. You have to add $expand=Invoicing.DefaultInvoiceAddress in your request URI to get this field

": "{String}",
130
                    "postalCode
PostalCode

Postalcode/Postcode/ZIP

This field is greyed out because it is an expandable field. You have to add $expand=Invoicing.DefaultInvoiceAddress in your request URI to get this field

": "{String}",
131
                    "city
City

City/town/village

This field is greyed out because it is an expandable field. You have to add $expand=Invoicing.DefaultInvoiceAddress in your request URI to get this field

": "{String}",
132
                    "region
Region

Region/province/state

This field is greyed out because it is an expandable field. You have to add $expand=Invoicing.DefaultInvoiceAddress in your request URI to get this field

": "{String}",
133
                    "countryCode
CountryCode

Two-character code (ISO 3166) identifying the country.

This field is greyed out because it is an expandable field. You have to add $expand=Invoicing.DefaultInvoiceAddress in your request URI to get this field

": "{String}",
134
                    "country
Country

English name of country.

This field is greyed out because it is an expandable field. You have to add $expand=Invoicing.DefaultInvoiceAddress in your request URI to get this field

": "{String}",
135
                    "addressLink
AddressLink

Address reference

This field is greyed out because it is an expandable field. You have to add $expand=Invoicing.DefaultInvoiceAddress in your request URI to get this field

": "{String}"
136
               }
137
          },
138
          "payment": {
139
               "paymentTerms
PaymentTerms

Default payment terms to use in new documents.

Possible domain values can be found here

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

Default payment method for the customer

Possible domain values can be found here

": "{String}",
141
               "latestPaymentDate
LatestPaymentDate

Date last payment was registered

": "{Date}"
142
          },
143
          "accounting": {
144
               "currency
Currency

Three character code following the ISO 4217 standard

": "{String}",
145
               "balance
Balance

Total balance for the customer, without value added tax

": "{Decimal}",
146
               "balanceIncludingVAT
BalanceIncludingVAT

Total balance for the customer. Positive amount indicates how much the customer owes. Negative amount indicates that the customer has a credit balance.

": "{Decimal}",
147
               "billingYTDAmount
BillingYTDAmount

Total amount of invoices and credit notes that has been invoiced this year (to current date)

": "{Decimal}",
148
               "overdueAmount
OverdueAmount

Total amount of unpaid invoices which has passed due date

": "{Decimal}",
149
               "creditLimit
CreditLimit

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

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

Credit amount insured for the customer

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

Insurance company used by the customer for credit insurance

": "{String}"
152
          },
153
          "auction
Auction

This field is greyed out because it is an expandable field. You have to add $expand=Auction in your request URI to get this field

": {
154
               "feePercent
FeePercent

The commission paid by the customer when purchasing LOTs

This field is greyed out because it is an expandable field. You have to add $expand=Auction in your request URI to get this field

": "{Decimal}",
155
               "latestBidDate
LatestBidDate

Last date the customer placed a bid.

This field is greyed out because it is an expandable field. You have to add $expand=Auction in your request URI to get this field

": "{Date}",
156
               "crossReference
CrossReference

This field is greyed out because it is an expandable field. You have to add $expand=Auction in your request URI to get this field

": {
157
                    "supplier
Supplier

Every customer in auction companies has a cross-reference to a supplier.

This field is greyed out because it is an expandable field. You have to add $expand=Auction in your request URI to get this field

": {
158
                         "supplierId
SupplierId

RamBase supplier identifier

This field is greyed out because it is an expandable field. You have to add $expand=Auction in your request URI to get this field

": "{Integer}",
159
                         "supplierLink
SupplierLink

Supplier reference

This field is greyed out because it is an expandable field. You have to add $expand=Auction in your request URI to get this field

": "{String}"
160
                    },
161
                    "totalBalance
TotalBalance

Sum of customer and cross referenced supplier balances

This field is greyed out because it is an expandable field. You have to add $expand=Auction in your request URI to get this field

": "{Decimal}",
162
                    "totalOverdueAmount
TotalOverdueAmount

Sum of customer and cross referenced supplier overdued amounts

This field is greyed out because it is an expandable field. You have to add $expand=Auction in your request URI to get this field

": "{Decimal}"
163
               }
164
          },
165
          "service
Service

This field is greyed out because it is an expandable field. You have to add $expand=Service in your request URI to get this field

": {
166
               "specialHandling
SpecialHandling

This field is greyed out because it is an expandable field. You have to add $expand=Service in your request URI to get this field

": {
167
                    "specialHandlingId
SpecialHandlingId

The special handling code used for service.

This field is greyed out because it is an expandable field. You have to add $expand=Service in your request URI to get this field

": "{Integer}",
168
                    "specialHandlingLink
SpecialHandlingLink

The special handling code used for service.

This field is greyed out because it is an expandable field. You have to add $expand=Service in your request URI to get this field

": "{String}"
169
               }
170
          }
171
     }
172
}

Possible error codes the response might return:

Error 100051 HTTP 400 When logged in as supplier {0} you do not have access to this API resource
Error 100055 HTTP 403 You have only admittance to your own objects