Sales APIs
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.
Customer
This field is optional.
>Name
Name of customer (name of company or surname/familyname/lastname of a person)
This field is optional.
>{String}</Name>IsCompany
Indicator if a customer is private entity or a company
This field is optional.
>{Boolean}</IsCompany>FirstName
Secondary name of a company or firstname of a person
This field is optional.
>{String}</FirstName>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>Website
Customers website/homepage/webpage
This field is optional.
>{String}</Website>Phone
Customers main phone number
This field is optional.
>{String}</Phone>Fax
Customers main fax number
This field is optional.
>{String}</Fax>Customers main email
Input must match the following regular expression pattern: ^\w+([-+.']\w+)*@\w+([-.]\w+)*\.\w+([-.]\w+)*$
This field is optional.
>{String}</Email>ExternalReference
External customer reference/identifier. Can be used in external systems.
This field is optional.
>{String}</ExternalReference>InternalNote
Internal note/notice of the customer. Should not be visible to the customer.
This field is optional.
>{String}</InternalNote>IsRelatedBusinessEntity
Identify if a customer is related business entity to the company
This field is optional.
>{Boolean}</IsRelatedBusinessEntity>LegalEntityIdentifier
The customers unique enterprise/organization number.
This field is optional.
>{String}</LegalEntityIdentifier>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>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>Classification
Classification of the customer
Applicable domain values can be found here
This field is optional.
>{String}</Classification>Intercompany
This field is optional.
>Code
Intercompany database the customer belongs to.
This field is optional.
>{String}</Code>Currencies
Currencies used by the customer
This field is optional.
>Currency
This field is optional.
>CurrencyCode
Three character code following the ISO 4217 standard
Applicable domain values can be found here
This field is optional.
>{String}</CurrencyCode>Sales
This field is optional.
>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>Sector
The sector the customer belongs to.
Applicable domain values can be found here
This field is optional.
>{String}</Sector>MarketSegment
Market segment of the customer
Applicable domain values can be found here
This field is optional.
>{String}</MarketSegment>MinimumGrossMargin
The minimum gross margin in percent for the customer
Minimum value: 0
Maximum value: 99
This field is optional.
>{Decimal}</MinimumGrossMargin>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>WarrantyPeriod
Agreement of default warranty period in months
Minimum value: 0
This field is optional.
>{Integer}</WarrantyPeriod>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>VolumePriceAgreement
Special price agreement related to the quantity beeing ordered.
Applicable domain values can be found here
This field is optional.
>{String}</VolumePriceAgreement>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>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>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>PriceList
This field is optional.
>PriceListId
Price list identifier
Minimum value: 100000
This field is optional.
>{Integer}</PriceListId>SalesAssistant
Reference to the employee who is sales assistant for the customer.
This field is optional.
>EmployeeId
Employee identifier
Minimum value: 100
This field is optional.
>{Integer}</EmployeeId>AccountManager
Reference to the employee who is responsible for the management of sales, and relationship with the customer.
This field is optional.
>EmployeeId
Employee identifier
Minimum value: 100
This field is optional.
>{Integer}</EmployeeId>Shipment
This field is optional.
>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>DeliveryTermPlace
Named place related to delivery terms (Incoterms)
This field is optional.
>{String}</DeliveryTermPlace>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>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>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>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>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>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>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>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>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>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>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>SpecialHandling
This field is optional.
>SpecialHandlingId
The special handling code used for this customer.
Minimum value: 0
This field is optional.
>{Integer}</SpecialHandlingId>ShippingService
This field is optional.
>ShippingServiceId
Shipping service identifier
Minimum value: 100000
This field is optional.
>{Integer}</ShippingServiceId>Invoicing
This field is optional.
>InterestRate
Interest rate used for sales invoices past duedate
Minimum value: 0
Maximum value: 1000
This field is optional.
>{Decimal}</InterestRate>InterestFeeAmount
Fixed interest fee used for the customer.
Minimum value: 0
This field is optional.
>{Decimal}</InterestFeeAmount>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>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>SalesInvoiceItemSortBy
Field name to sort by when creating sales invoice items.
Applicable domain values can be found here
This field is optional.
>{String}</SalesInvoiceItemSortBy>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>SendToFactoring
Identify which customer, invoices ands credit notes, will be send to factoring
This field is optional.
>{Boolean}</SendToFactoring>Payment
This field is optional.
>PaymentTerms
Default payment terms to use in new documents.
Applicable domain values can be found here
This field is optional.
>{String}</PaymentTerms>PaymentMethod
Default payment method for the customer
Applicable domain values can be found here
This field is optional.
>{String}</PaymentMethod>Accounting
This field is optional.
>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>CreditInsuranceAmount
Credit amount insured for the customer
Minimum value: 0
This field is optional.
>{Decimal}</CreditInsuranceAmount>CreditInsuranceCompany
Insurance company used by the customer for credit insurance
This field is optional.
>{String}</CreditInsuranceCompany>Auction
This field is optional.
>FeePercent
The commission paid by the customer when purchasing LOTs
Minimum value: 0
Maximum value: 100
This field is optional.
>{Decimal}</FeePercent>Service
This field is optional.
>SpecialHandling
This field is optional.
>SpecialHandlingId
The special handling code used for service.
Minimum value: 100000
This field is optional.
>{Integer}</SpecialHandlingId>Customer
This field is optional.
": {Name
Name of customer (name of company or surname/familyname/lastname of a person)
This field is optional.
": "{String}",IsCompany
Indicator if a customer is private entity or a company
This field is optional.
": "{Boolean}",FirstName
Secondary name of a company or firstname of a person
This field is optional.
": "{String}",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}",Website
Customers website/homepage/webpage
This field is optional.
": "{String}",Phone
Customers main phone number
This field is optional.
": "{String}",Fax
Customers main fax number
This field is optional.
": "{String}",Customers main email
Input must match the following regular expression pattern: ^\w+([-+.']\w+)*@\w+([-.]\w+)*\.\w+([-.]\w+)*$
This field is optional.
": "{String}",ExternalReference
External customer reference/identifier. Can be used in external systems.
This field is optional.
": "{String}",InternalNote
Internal note/notice of the customer. Should not be visible to the customer.
This field is optional.
": "{String}",IsRelatedBusinessEntity
Identify if a customer is related business entity to the company
This field is optional.
": "{Boolean}",LegalEntityIdentifier
The customers unique enterprise/organization number.
This field is optional.
": "{String}",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}",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}",Classification
Classification of the customer
Applicable domain values can be found here
This field is optional.
": "{String}",Intercompany
This field is optional.
": {Code
Intercompany database the customer belongs to.
This field is optional.
": "{String}"Currencies
Currencies used by the customer
This field is optional.
": [CurrencyCode
Three character code following the ISO 4217 standard
Applicable domain values can be found here
This field is optional.
": "{String}"Sales
This field is optional.
": {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}",Sector
The sector the customer belongs to.
Applicable domain values can be found here
This field is optional.
": "{String}",MarketSegment
Market segment of the customer
Applicable domain values can be found here
This field is optional.
": "{String}",MinimumGrossMargin
The minimum gross margin in percent for the customer
Minimum value: 0
Maximum value: 99
This field is optional.
": "{Decimal}",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}",WarrantyPeriod
Agreement of default warranty period in months
Minimum value: 0
This field is optional.
": "{Integer}",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}",VolumePriceAgreement
Special price agreement related to the quantity beeing ordered.
Applicable domain values can be found here
This field is optional.
": "{String}",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}",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}",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}",PriceList
This field is optional.
": {PriceListId
Price list identifier
Minimum value: 100000
This field is optional.
": "{Integer}"SalesAssistant
Reference to the employee who is sales assistant for the customer.
This field is optional.
": {EmployeeId
Employee identifier
Minimum value: 100
This field is optional.
": "{Integer}"AccountManager
Reference to the employee who is responsible for the management of sales, and relationship with the customer.
This field is optional.
": {EmployeeId
Employee identifier
Minimum value: 100
This field is optional.
": "{Integer}"Shipment
This field is optional.
": {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}",DeliveryTermPlace
Named place related to delivery terms (Incoterms)
This field is optional.
": "{String}",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}",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}",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}",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}",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}",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}",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}",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}",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}",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}",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}",SpecialHandling
This field is optional.
": {SpecialHandlingId
The special handling code used for this customer.
Minimum value: 0
This field is optional.
": "{Integer}"ShippingService
This field is optional.
": {ShippingServiceId
Shipping service identifier
Minimum value: 100000
This field is optional.
": "{Integer}"Invoicing
This field is optional.
": {InterestRate
Interest rate used for sales invoices past duedate
Minimum value: 0
Maximum value: 1000
This field is optional.
": "{Decimal}",InterestFeeAmount
Fixed interest fee used for the customer.
Minimum value: 0
This field is optional.
": "{Decimal}",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}",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}",SalesInvoiceItemSortBy
Field name to sort by when creating sales invoice items.
Applicable domain values can be found here
This field is optional.
": "{String}",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}",SendToFactoring
Identify which customer, invoices ands credit notes, will be send to factoring
This field is optional.
": "{Boolean}"Payment
This field is optional.
": {PaymentTerms
Default payment terms to use in new documents.
Applicable domain values can be found here
This field is optional.
": "{String}",PaymentMethod
Default payment method for the customer
Applicable domain values can be found here
This field is optional.
": "{String}"Accounting
This field is optional.
": {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}",CreditInsuranceAmount
Credit amount insured for the customer
Minimum value: 0
This field is optional.
": "{Decimal}",CreditInsuranceCompany
Insurance company used by the customer for credit insurance
This field is optional.
": "{String}"Auction
This field is optional.
": {FeePercent
The commission paid by the customer when purchasing LOTs
Minimum value: 0
Maximum value: 100
This field is optional.
": "{Decimal}"Service
This field is optional.
": {SpecialHandling
This field is optional.
": {SpecialHandlingId
The special handling code used for service.
Minimum value: 100000
This field is optional.
": "{Integer}"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.
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 |