Sales APIs
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.
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.
CustomerId
Customer identifier
>{Integer}</CustomerId>Status
Status of the customer. 1:New, 2:Pending internal approvement, 4:Active, 9:Obsolete
Possible domain values can be found here
>{Integer}</Status>Name
Name of customer (name of company or surname/familyname/lastname of a person)
>{String}</Name>IsCompany
Indicator if a customer is private entity or a company
>{Boolean}</IsCompany>FirstName
Secondary name of a company or firstname of a person
>{String}</FirstName>PreferredLanguage
Preferred language for the customer. Is used in prints etc.
Possible domain values can be found here
>{String}</PreferredLanguage>Website
Customers website/homepage/webpage
>{String}</Website>Phone
Customers main phone number
>{String}</Phone>Fax
Customers main fax number
>{String}</Fax>Customers main email
>{String}</Email>ExternalReference
External customer reference/identifier. Can be used in external systems.
>{String}</ExternalReference>InternalNote
Internal note/notice of the customer. Should not be visible to the customer.
>{String}</InternalNote>IsRelatedBusinessEntity
Identify if a customer is related business entity to the company
>{Boolean}</IsRelatedBusinessEntity>LegalEntityIdentifier
The customers unique enterprise/organization number.
>{String}</LegalEntityIdentifier>VATRegistrationNumber
Unique number assigned by the relevant tax authority to identify a party for use in relation to value added tax (VAT).
>{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.
>{String}</EORINumber>Classification
Classification of the customer
Possible domain values can be found here
>{String}</Classification>UpdatedAt
Date and time of update
>{Datetime}</UpdatedAt>CreatedAt
Date and time of creation
>{Datetime}</CreatedAt>CreatedBy
The employee (might be RamBase-server) that created the customer
>UserId
User identifier
>{Integer}</UserId>Name
Name of the user
>{String}</Name>FirstName
First name of the user
>{String}</FirstName>UserLink
User reference
>{String}</UserLink>Code
Intercompany database the customer belongs to.
>{String}</Code>Currencies
Currencies used by the customer
>CurrencyCode
Three character code following the ISO 4217 standard
Possible domain values can be found here
>{String}</CurrencyCode>Currency
Three character code following the ISO 4217 standard
>{String}</Currency>BacklogAmount
Total amount of sales orders, excluding value added tax, that not yet has been fulfilled.
>{Decimal}</BacklogAmount>BacklogAmountIncludingVAT
Total amount of sales orders, including value added tax, that not yet has been fulfilled
>{Decimal}</BacklogAmountIncludingVAT>SalesDistrict
A geographic district for which an individual salesperson or sales team holds responsibility
Possible domain values can be found here
>{String}</SalesDistrict>Sector
The sector the customer belongs to.
Possible domain values can be found here
>{String}</Sector>MarketSegment
Market segment of the customer
Possible domain values can be found here
>{String}</MarketSegment>MinimumGrossMargin
The minimum gross margin in percent for the customer
>{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.
Possible domain values can be found here
>{String}</VATHandling>WarrantyPeriod
Agreement of default warranty period in months
>{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.
>{Decimal}</FeeAmount>VolumePriceAgreement
Special price agreement related to the quantity beeing ordered.
Possible domain values can be found here
>{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.
Possible domain values can be found here
>{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.
>{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.
>{Boolean}</BlockSalesQuoteRegistration>LatestSalesOrderDate
Date of latest sales order or sales order request registration.
>{Date}</LatestSalesOrderDate>PriceListId
Price list identifier
>{Integer}</PriceListId>Name
Name of the price list
>{String}</Name>PriceListLink
Price list reference
>{String}</PriceListLink>SalesAssistant
Reference to the employee who is sales assistant for the customer.
>EmployeeId
Employee identifier
>{Integer}</EmployeeId>LastName
Last name of employee
>{String}</LastName>FirstName
First name of employee
>{String}</FirstName>EmployeeLink
Employee reference
>{String}</EmployeeLink>AccountManager
Reference to the employee who is responsible for the management of sales, and relationship with the customer.
>EmployeeId
Employee identifier
>{Integer}</EmployeeId>LastName
Last name of employee
>{String}</LastName>FirstName
First name of employee
>{String}</FirstName>EmployeeLink
Employee reference
>{String}</EmployeeLink>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>DeliveryTermPlace
Named place related to delivery terms (Incoterms)
>{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.
>{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.
>{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.
>{Boolean}</AvoidMultipleShipmentsOnSameDate>ShipBasedOnConfirmedDeliveryDate
If true, will sheduled shipping date on each item be calculated based on confirmed date rather than requested date.
>{Boolean}</ShipBasedOnConfirmedDeliveryDate>FreightForEachShipment
If unchecked there will only be calculated freight on one shipping advice if the particular sales order has serveral shipments.
>{Boolean}</FreightForEachShipment>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>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>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>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>RequireApprovalIfOverdue
True if shipments need approval if there are sales invoices with overdue amount. Default value is retireved from setting: DefaultCreateValueCUSFieldDUEAPPROVE
>{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.
>{Boolean}</BlockShipping>SpecialHandlingId
The special handling code used for this customer.
>{Integer}</SpecialHandlingId>SpecialHandlingLink
The special handling code used for this customer.
>{String}</SpecialHandlingLink>ShippingServiceId
Shipping service identifier
>{Integer}</ShippingServiceId>Name
Name of shipping service
>{String}</Name>ShippingServiceLink
Shipping service reference
>{String}</ShippingServiceLink>Currency
Three character code following the ISO 4217 standard
>{String}</Currency>InterestRate
Interest rate used for sales invoices past duedate
>{Decimal}</InterestRate>InterestFeeAmount
Fixed interest fee used for the customer.
>{Decimal}</InterestFeeAmount>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>SalesInvoiceConsolidationField
Field name to group by when consolidating shipping advice items into sales invoices.
Possible domain values can be found here
>{String}</SalesInvoiceConsolidationField>SalesInvoiceItemSortBy
Field name to sort by when creating sales invoice items.
Possible domain values can be found here
>{String}</SalesInvoiceItemSortBy>SendReminders
Set to false if reminder are not be sent to this customer. Default value is retireved from setting: DefaultCreateValueCUSFieldREMINDER
>{Boolean}</SendReminders>LatestSalesInvoiceDate
Date last sales invoice was registered.
>{Date}</LatestSalesInvoiceDate>SendToFactoring
Identify which customer, invoices ands credit notes, will be send to factoring
>{Boolean}</SendToFactoring>PaymentTerms
Default payment terms to use in new documents.
Possible domain values can be found here
>{String}</PaymentTerms>PaymentMethod
Default payment method for the customer
Possible domain values can be found here
>{String}</PaymentMethod>LatestPaymentDate
Date last payment was registered
>{Date}</LatestPaymentDate>Currency
Three character code following the ISO 4217 standard
>{String}</Currency>Balance
Total balance for the customer, without value added tax
>{Decimal}</Balance>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>BillingYTDAmount
Total amount of invoices and credit notes that has been invoiced this year (to current date)
>{Decimal}</BillingYTDAmount>OverdueAmount
Total amount of unpaid invoices which has passed due date
>{Decimal}</OverdueAmount>CreditLimit
The maximum amount that the customer may charge on a credit card or borrow from a financial institution.
>{Decimal}</CreditLimit>CreditInsuranceAmount
Credit amount insured for the customer
>{Decimal}</CreditInsuranceAmount>CreditInsuranceCompany
Insurance company used by the customer for credit insurance
>{String}</CreditInsuranceCompany>CustomerId
Customer identifier
": "{Integer}",Status
Status of the customer. 1:New, 2:Pending internal approvement, 4:Active, 9:Obsolete
Possible domain values can be found here
": "{Integer}",Name
Name of customer (name of company or surname/familyname/lastname of a person)
": "{String}",IsCompany
Indicator if a customer is private entity or a company
": "{Boolean}",FirstName
Secondary name of a company or firstname of a person
": "{String}",PreferredLanguage
Preferred language for the customer. Is used in prints etc.
Possible domain values can be found here
": "{String}",Website
Customers website/homepage/webpage
": "{String}",Phone
Customers main phone number
": "{String}",Fax
Customers main fax number
": "{String}",Customers main email
": "{String}",ExternalReference
External customer reference/identifier. Can be used in external systems.
": "{String}",InternalNote
Internal note/notice of the customer. Should not be visible to the customer.
": "{String}",IsRelatedBusinessEntity
Identify if a customer is related business entity to the company
": "{Boolean}",LegalEntityIdentifier
The customers unique enterprise/organization number.
": "{String}",VATRegistrationNumber
Unique number assigned by the relevant tax authority to identify a party for use in relation to value added tax (VAT).
": "{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.
": "{String}",Classification
Classification of the customer
Possible domain values can be found here
": "{String}",UpdatedAt
Date and time of update
": "{Datetime}",CreatedAt
Date and time of creation
": "{Datetime}",CreatedBy
The employee (might be RamBase-server) that created the customer
": {UserId
User identifier
": "{Integer}",Name
Name of the user
": "{String}",FirstName
First name of the user
": "{String}",UserLink
User reference
": "{String}"Code
Intercompany database the customer belongs to.
": "{String}"Currencies
Currencies used by the customer
": [CurrencyCode
Three character code following the ISO 4217 standard
Possible domain values can be found here
": "{String}"Currency
Three character code following the ISO 4217 standard
": "{String}",BacklogAmount
Total amount of sales orders, excluding value added tax, that not yet has been fulfilled.
": "{Decimal}",BacklogAmountIncludingVAT
Total amount of sales orders, including value added tax, that not yet has been fulfilled
": "{Decimal}",SalesDistrict
A geographic district for which an individual salesperson or sales team holds responsibility
Possible domain values can be found here
": "{String}",Sector
The sector the customer belongs to.
Possible domain values can be found here
": "{String}",MarketSegment
Market segment of the customer
Possible domain values can be found here
": "{String}",MinimumGrossMargin
The minimum gross margin in percent for the customer
": "{Decimal}",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}",WarrantyPeriod
Agreement of default warranty period in months
": "{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.
": "{Decimal}",VolumePriceAgreement
Special price agreement related to the quantity beeing ordered.
Possible domain values can be found here
": "{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.
Possible domain values can be found here
": "{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.
": "{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.
": "{Boolean}",LatestSalesOrderDate
Date of latest sales order or sales order request registration.
": "{Date}",PriceListId
Price list identifier
": "{Integer}",Name
Name of the price list
": "{String}",PriceListLink
Price list reference
": "{String}"SalesAssistant
Reference to the employee who is sales assistant for the customer.
": {EmployeeId
Employee identifier
": "{Integer}",LastName
Last name of employee
": "{String}",FirstName
First name of employee
": "{String}",EmployeeLink
Employee reference
": "{String}"AccountManager
Reference to the employee who is responsible for the management of sales, and relationship with the customer.
": {EmployeeId
Employee identifier
": "{Integer}",LastName
Last name of employee
": "{String}",FirstName
First name of employee
": "{String}",EmployeeLink
Employee reference
": "{String}"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}",DeliveryTermPlace
Named place related to delivery terms (Incoterms)
": "{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.
": "{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.
": "{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.
": "{Boolean}",ShipBasedOnConfirmedDeliveryDate
If true, will sheduled shipping date on each item be calculated based on confirmed date rather than requested date.
": "{Boolean}",FreightForEachShipment
If unchecked there will only be calculated freight on one shipping advice if the particular sales order has serveral shipments.
": "{Boolean}",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}",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}",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}",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}",RequireApprovalIfOverdue
True if shipments need approval if there are sales invoices with overdue amount. Default value is retireved from setting: DefaultCreateValueCUSFieldDUEAPPROVE
": "{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.
": "{Boolean}",SpecialHandlingId
The special handling code used for this customer.
": "{Integer}",SpecialHandlingLink
The special handling code used for this customer.
": "{String}"ShippingServiceId
Shipping service identifier
": "{Integer}",Name
Name of shipping service
": "{String}",ShippingServiceLink
Shipping service reference
": "{String}"Currency
Three character code following the ISO 4217 standard
": "{String}",InterestRate
Interest rate used for sales invoices past duedate
": "{Decimal}",InterestFeeAmount
Fixed interest fee used for the customer.
": "{Decimal}",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}",SalesInvoiceConsolidationField
Field name to group by when consolidating shipping advice items into sales invoices.
Possible domain values can be found here
": "{String}",SalesInvoiceItemSortBy
Field name to sort by when creating sales invoice items.
Possible domain values can be found here
": "{String}",SendReminders
Set to false if reminder are not be sent to this customer. Default value is retireved from setting: DefaultCreateValueCUSFieldREMINDER
": "{Boolean}",LatestSalesInvoiceDate
Date last sales invoice was registered.
": "{Date}",SendToFactoring
Identify which customer, invoices ands credit notes, will be send to factoring
": "{Boolean}",PaymentTerms
Default payment terms to use in new documents.
Possible domain values can be found here
": "{String}",PaymentMethod
Default payment method for the customer
Possible domain values can be found here
": "{String}",LatestPaymentDate
Date last payment was registered
": "{Date}"Currency
Three character code following the ISO 4217 standard
": "{String}",Balance
Total balance for the customer, without value added tax
": "{Decimal}",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}",BillingYTDAmount
Total amount of invoices and credit notes that has been invoiced this year (to current date)
": "{Decimal}",OverdueAmount
Total amount of unpaid invoices which has passed due date
": "{Decimal}",CreditLimit
The maximum amount that the customer may charge on a credit card or borrow from a financial institution.
": "{Decimal}",CreditInsuranceAmount
Credit amount insured for the customer
": "{Decimal}",CreditInsuranceCompany
Insurance company used by the customer for credit insurance
": "{String}"
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 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 |