API

Sales APIs

POST sales/quotes

Creates a new sales quote

HTTP method POST
URI https://api.rambase.net/sales/quotes
Supported formats Xml, Html, Json (ex. $format=json)
Custom fields Custom fields supported
Successful HTTP status code 201
API resource identifier 2049, version 12

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
<SalesQuote>
2
     <CustomersReference
CustomersReference

Customers reference. Typically a person.

This field is optional.

>{String}</CustomersReference>
3
     <CustomersReferenceNumber
CustomersReferenceNumber

Customers reference number. E.g. the internal sales order id the customer use in their own system.

This field is optional.

>{String}</CustomersReferenceNumber>
4
     <VolumePriceAgreement
VolumePriceAgreement

Special price agreement related to the quantity beeing ordered.

Applicable domain values can be found here

This field is optional.

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

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

Applicable domain values can be found here

This field is optional.

>{String}</ExchangeRateFluctuationAgreement>
6
     <Currency
Currency

Three character code following the ISO 4217 standard

Applicable domain values can be found here

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

This field is optional.

>{String}</Currency>
7
     <Note
Note

Additional information regarding the object (free text). This note might be visible to customers/suppliers.

This field is optional.

>{String}</Note>
8
     <Location
Location

This field is optional.

>
9
          <LocationId
LocationId

Location identifier

Minimum value: 10000

This field is optional.

>{Integer}</LocationId>
10
     </Location>
11
     <Validity
Validity

This field is optional.

>
12
          <EffectiveDate
EffectiveDate

The date the sales quote takes effect. The quote will be effective from from and including this date.

This field is optional.

>{Date}</EffectiveDate>
13
          <ExpirationDate
ExpirationDate

The date the sales quote expires. The quote will be active to and including this date.

This field is optional.

>{Date}</ExpirationDate>
14
     </Validity>
15
     <Customer>
16
          <CustomerId
CustomerId

Required/mandatory field

Customer identifier

Minimum value: 10000

>{Integer}</CustomerId>
17
     </Customer>
18
     <ShippingAddress
ShippingAddress

This field is optional.

>
19
          <AddressId
AddressId

Address identifier

Minimum value: 1

This field is optional.

>{Integer}</AddressId>
20
     </ShippingAddress>
21
     <Shipment
Shipment

This field is optional.

>
22
          <DeliveryTerms
DeliveryTerms

Delivery terms when shipping the goods. The delivery terms is based on the Incoterms rules from ICC (International Chamber of Commerce). The delivery terms is by default retrieved from the customer.

Applicable domain values can be found here

This field is optional.

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

Named place related to delivery terms (Incoterms)

This field is optional.

>{String}</DeliveryTermPlace>
24
          <ShippingService
ShippingService

This field is optional.

>
25
               <ShippingServiceId
ShippingServiceId

Shipping service identifier

This field is optional.

>{Integer}</ShippingServiceId>
26
          </ShippingService>
27
     </Shipment>
28
     <Payment
Payment

This field is optional.

>
29
          <PaymentTerms
PaymentTerms

Terms of payment. Defaut value is retrieved from the customer. The due date of the sales order and sales invoice is calculated based on this field.

Applicable domain values can be found here

This field is optional.

>{String}</PaymentTerms>
30
     </Payment>
31
     <SalesOpportunity
SalesOpportunity

This field is optional.

>
32
          <SalesOpportunityId
SalesOpportunityId

Sales opportunity identifier

Minimum value: 100000

This field is optional.

>{Integer}</SalesOpportunityId>
33
     </SalesOpportunity>
34
     <VATDetails
VATDetails

This field is optional.

>
35
          <VATHandling
VATHandling

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

Applicable domain values can be found here

This field is optional.

>{String}</VATHandling>
36
     </VATDetails>
37
</SalesQuote>
1
{
2
     "salesQuote": {
3
          "customersReference
CustomersReference

Customers reference. Typically a person.

This field is optional.

": "{String}",
4
          "customersReferenceNumber
CustomersReferenceNumber

Customers reference number. E.g. the internal sales order id the customer use in their own system.

This field is optional.

": "{String}",
5
          "volumePriceAgreement
VolumePriceAgreement

Special price agreement related to the quantity beeing ordered.

Applicable domain values can be found here

This field is optional.

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

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

Applicable domain values can be found here

This field is optional.

": "{String}",
7
          "currency
Currency

Three character code following the ISO 4217 standard

Applicable domain values can be found here

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

This field is optional.

": "{String}",
8
          "note
Note

Additional information regarding the object (free text). This note might be visible to customers/suppliers.

This field is optional.

": "{String}",
9
          "location
Location

This field is optional.

": {
10
               "locationId
LocationId

Location identifier

Minimum value: 10000

This field is optional.

": "{Integer}"
11
          },
12
          "validity
Validity

This field is optional.

": {
13
               "effectiveDate
EffectiveDate

The date the sales quote takes effect. The quote will be effective from from and including this date.

This field is optional.

": "{Date}",
14
               "expirationDate
ExpirationDate

The date the sales quote expires. The quote will be active to and including this date.

This field is optional.

": "{Date}"
15
          },
16
          "customer": {
17
               "customerId
CustomerId

Required/mandatory field

Customer identifier

Minimum value: 10000

": "{Integer}"
18
          },
19
          "shippingAddress
ShippingAddress

This field is optional.

": {
20
               "addressId
AddressId

Address identifier

Minimum value: 1

This field is optional.

": "{Integer}"
21
          },
22
          "shipment
Shipment

This field is optional.

": {
23
               "deliveryTerms
DeliveryTerms

Delivery terms when shipping the goods. The delivery terms is based on the Incoterms rules from ICC (International Chamber of Commerce). The delivery terms is by default retrieved from the customer.

Applicable domain values can be found here

This field is optional.

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

Named place related to delivery terms (Incoterms)

This field is optional.

": "{String}",
25
               "shippingService
ShippingService

This field is optional.

": {
26
                    "shippingServiceId
ShippingServiceId

Shipping service identifier

This field is optional.

": "{Integer}"
27
               }
28
          },
29
          "payment
Payment

This field is optional.

": {
30
               "paymentTerms
PaymentTerms

Terms of payment. Defaut value is retrieved from the customer. The due date of the sales order and sales invoice is calculated based on this field.

Applicable domain values can be found here

This field is optional.

": "{String}"
31
          },
32
          "salesOpportunity
SalesOpportunity

This field is optional.

": {
33
               "salesOpportunityId
SalesOpportunityId

Sales opportunity identifier

Minimum value: 100000

This field is optional.

": "{Integer}"
34
          },
35
          "vATDetails
VATDetails

This field is optional.

": {
36
               "vATHandling
VATHandling

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

Applicable domain values can be found here

This field is optional.

": "{String}"
37
          }
38
     }
39
}

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.
$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]
$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.

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

Format:
1
<SalesQuote>
2
     <SalesQuoteId
SalesQuoteId

Sales quote identifier

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

Status of sales quote

Possible domain values can be found here

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

Date and time of creation

>{Datetime}</CreatedAt>
5
     <RegistrationDate
RegistrationDate

Date of registration

>{Date}</RegistrationDate>
6
     <SellersReferenceNumber
SellersReferenceNumber

Sellers reference number.

>{String}</SellersReferenceNumber>
7
     <CustomersReference
CustomersReference

Customers reference. Typically a person.

>{String}</CustomersReference>
8
     <CustomersReferenceNumber
CustomersReferenceNumber

Customers reference number. E.g. the internal sales order id the customer use in their own system.

>{String}</CustomersReferenceNumber>
9
     <VolumePriceAgreement
VolumePriceAgreement

Special price agreement related to the quantity beeing ordered.

Possible domain values can be found here

>{String}</VolumePriceAgreement>
10
     <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>
11
     <NetWeight
NetWeight

The net weight of object (excluding packing meterial) in kilograms

>{Decimal}</NetWeight>
12
     <GrossMargin
GrossMargin

Gross margin of sale, calculated as an average of gross margin of all items at the time items are created and when the document is registered. Will not be recalculated if gross margin in items change afterwards

>{Decimal}</GrossMargin>
13
     <Currency
Currency

Three character code following the ISO 4217 standard

Possible domain values can be found here

>{String}</Currency>
14
     <HasAttachmentsToForward
HasAttachmentsToForward

Has attachements that will be included when forwarded to other transaction documents.

>{Boolean}</HasAttachmentsToForward>
15
     <Note
Note

Additional information regarding the object (free text). This note might be visible to customers/suppliers.

>{String}</Note>
16
     <ShippingAddressAttention
ShippingAddressAttention

Attention of the shipping address. When changing shipping address, the ShippingAddressAttention will be overridden by the attention of the new shipping address.

>{String}</ShippingAddressAttention>
17
     <InvoiceAddressAttention
InvoiceAddressAttention

Attention of the invoice address. When changing invoice address, the InvoiceAddressAttention will be overridden by the attention of the new invoice address.

>{String}</InvoiceAddressAttention>
18
     <LocationCountryCode
LocationCountryCode

Country code of the location. Inherits from the location.

>{String}</LocationCountryCode>
19
     <Location>
20
          <ShortName
ShortName

Unique abbreviation/short name of the location

>
21
               <CountryCode
CountryCode

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

>{String}</CountryCode>
22
          </ShortName>
23
     </Location>
24
     <Assignee
Assignee

The user who has been assigned to work with this object.

>
25
          <UserId
UserId

User identifier

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

Name of the user

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

First name of the user

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

User reference

>{String}</UserLink>
29
     </Assignee>
30
     <Validity>
31
          <EffectiveDate
EffectiveDate

The date the sales quote takes effect. The quote will be effective from from and including this date.

>{Date}</EffectiveDate>
32
          <ExpirationDate
ExpirationDate

The date the sales quote expires. The quote will be active to and including this date.

>{Date}</ExpirationDate>
33
     </Validity>
34
     <Customer>
35
          <CustomerId
CustomerId

Customer identifier

>{Integer}</CustomerId>
36
          <Name
Name

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

>{String}</Name>
37
          <Firstname
Firstname

Secondary name of a company or firstname of a person

>{String}</Firstname>
38
          <Sales>
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
               <MarketSegment
MarketSegment

Market segment of the customer

Possible domain values can be found here

>
41
                    <EmployeeId
EmployeeId

Employee identifier

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

Last name of employee

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

First name of employee

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

Employee reference

>{String}</EmployeeLink>
45
                    <EmployeeId
EmployeeId

Employee identifier

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

Last name of employee

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

First name of employee

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

Employee reference

>{String}</EmployeeLink>
49
               </MarketSegment>
50
          </Sales>
51
          <CustomerLegalEntity>
52
               <CustomerLegalEntityId
CustomerLegalEntityId

Customer legal entity identifier

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

Reference to customer legal entity

>{String}</CustomerLegalEntityLink>
54
          </CustomerLegalEntity>
55
          <CustomerLink
CustomerLink

Customer reference

>{String}</CustomerLink>
56
     </Customer>
57
     <ShippingAddress>
58
          <AddressId
AddressId

Address identifier

>{Integer}</AddressId>
59
          <Name
Name

Name of receiver (Name of company or last name of a person). Note that default invoice address must have the same name as the customer.

>{String}</Name>
60
          <Firstname
Firstname

Firstname if the receiver is a person. Note that default invoice address must have the same firstname as the customer.

>{String}</Firstname>
61
          <AddressLine1
AddressLine1

First address line

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

Second address line

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

Postalcode/Postcode/ZIP

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

City/town/village

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

Region/province/state

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

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

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

English name of country.

>{String}</Country>
68
          <ExternalReference
ExternalReference

External address identifier. Normally defined by the customer.

>{String}</ExternalReference>
69
     </ShippingAddress>
70
     <InvoiceAddress>
71
          <Name
Name

Name of receiver (Name of company or last name of a person). Note that default invoice address must have the same name as the customer.

>{String}</Name>
72
          <Firstname
Firstname

Firstname if the receiver is a person. Note that default invoice address must have the same firstname as the customer.

>{String}</Firstname>
73
          <AddressLine1
AddressLine1

First address line

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

Second address line

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

Postalcode/Postcode/ZIP

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

City/town/village

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

Region/province/state

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

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

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

English name of country.

>{String}</Country>
80
     </InvoiceAddress>
81
     <Totals>
82
          <Currency
Currency

Three character code following the ISO 4217 standard

>{String}</Currency>
83
          <FreightAmount
FreightAmount

Freight amount in transaction document's currency

>{Decimal}</FreightAmount>
84
          <FeeAmount
FeeAmount

Fee amount in transaction document's currency

>{Decimal}</FeeAmount>
85
          <SubTotalAmount
SubTotalAmount

Total amount of the object in object currency, excluding VAT.

>{Decimal}</SubTotalAmount>
86
          <VATAmount
VATAmount

Total value added tax in object currency.

>{Decimal}</VATAmount>
87
          <TotalAmount
TotalAmount

The total amount in object currency, including VAT

>{Decimal}</TotalAmount>
88
          <Currency
Currency

Currency used in conversion. Default is company accounting currency. Three character code following the ISO 4217 standard.

>{String}</Currency>
89
          <ExchangeRate
ExchangeRate

The exchange rate used in convertion

>{Decimal}</ExchangeRate>
90
          <FreightAmount
FreightAmount

Freight amount in company currency.

>{Decimal}</FreightAmount>
91
          <FeeAmount
FeeAmount

Fee amount in company currency

>{Decimal}</FeeAmount>
92
          <SubTotalAmount
SubTotalAmount

Total amount of the object in company currency, excluding VAT.

>{Decimal}</SubTotalAmount>
93
          <VATAmount
VATAmount

Value added tax amount in company currency.

>{Decimal}</VATAmount>
94
          <TotalAmount
TotalAmount

The total amount in company currency, including VAT.

>{Decimal}</TotalAmount>
95
     </Totals>
96
     <Shipment>
97
          <DeliveryTerms
DeliveryTerms

Delivery terms when shipping the goods. The delivery terms is based on the Incoterms rules from ICC (International Chamber of Commerce). The delivery terms is by default retrieved from the customer.

Possible domain values can be found here

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

Named place related to delivery terms (Incoterms)

>{String}</DeliveryTermPlace>
99
          <OnlyShipEntireSalesOrder
OnlyShipEntireSalesOrder

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}</OnlyShipEntireSalesOrder>
100
          <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>
101
          <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>
102
          <ShipBasedOnConfirmedDeliveryDate
ShipBasedOnConfirmedDeliveryDate

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

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

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

>{Boolean}</FreightForEachShipment>
104
          <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>
105
          <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>
106
          <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>
107
          <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>
108
          <SpecialHandling
SpecialHandling

Special handling to use for this shipment.

>
109
               <SpecialHandlingId
SpecialHandlingId

Special handling identifier

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

Special handling code reference

>{String}</SpecialHandlingLink>
111
          </SpecialHandling>
112
          <ShippingService>
113
               <ShippingServiceId
ShippingServiceId

Shipping service identifier

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

Name of shipping service

>{String}</Name>
115
               <Carrier>
116
                    <CarrierId
CarrierId

Carrier identifier

>{Integer}</CarrierId>
117
                    <CarrierLink
CarrierLink

Carrier reference

>{String}</CarrierLink>
118
               </Carrier>
119
               <ShippingServiceLink
ShippingServiceLink

Shipping service reference

>{String}</ShippingServiceLink>
120
          </ShippingService>
121
     </Shipment>
122
     <Invoicing>
123
          <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>
124
          <SalesInvoiceConsolidationField
SalesInvoiceConsolidationField

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

Possible domain values can be found here

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

Field name to sort by when creating sales invoice items.

Possible domain values can be found here

>{String}</SalesInvoiceItemSortBy>
126
     </Invoicing>
127
     <Payment>
128
          <PaymentTerms
PaymentTerms

Terms of payment. Defaut value is retrieved from the customer. The due date of the sales order and sales invoice is calculated based on this field.

Possible domain values can be found here

>{String}</PaymentTerms>
129
     </Payment>
130
     <SalesOpportunity>
131
          <SalesOpportunityId
SalesOpportunityId

Sales opportunity identifier

>{Integer}</SalesOpportunityId>
132
          <SalesOpportunityLink
SalesOpportunityLink

Sales opportunity reference

>{String}</SalesOpportunityLink>
133
     </SalesOpportunity>
134
     <VATDetails>
135
          <VATType
VATType

Type of value added tax

>{String}</VATType>
136
          <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>
137
          <DefaultVATPercent
DefaultVATPercent

Value added tax percent.

>{Decimal}</DefaultVATPercent>
138
          <NotificationId
NotificationId

Notification identifier

>{Integer}</NotificationId>
139
          <Status
Status

Status of the notification

Possible domain values can be found here

>{Integer}</Status>
140
          <CreatedAt
CreatedAt

Date and time of creation

>{Datetime}</CreatedAt>
141
          <Message
Message

The message from the notification definition, expanded with parameters.

>{String}</Message>
142
          <TranslatedMessage
TranslatedMessage

The translated message from the notification definition, expanded with parameters.

>{String}</TranslatedMessage>
143
          <NotificationType>
144
               <NotificationTypeId
NotificationTypeId

Notification type identifier

>{String}</NotificationTypeId>
145
               <Category
Category

Category of notification type (warning, information etc)

Possible domain values can be found here

>{String}</Category>
146
               <NotificationTypeLink
NotificationTypeLink

Notification type reference

>{String}</NotificationTypeLink>
147
          </NotificationType>
148
          <NotificationLink
NotificationLink

Notification reference

>{String}</NotificationLink>
149
     </VATDetails>
150
</SalesQuote>
1
{
2
     "salesQuote": {
3
          "salesQuoteId
SalesQuoteId

Sales quote identifier

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

Status of sales quote

Possible domain values can be found here

": "{Integer}",
5
          "createdAt
CreatedAt

Date and time of creation

": "{Datetime}",
6
          "registrationDate
RegistrationDate

Date of registration

": "{Date}",
7
          "sellersReferenceNumber
SellersReferenceNumber

Sellers reference number.

": "{String}",
8
          "customersReference
CustomersReference

Customers reference. Typically a person.

": "{String}",
9
          "customersReferenceNumber
CustomersReferenceNumber

Customers reference number. E.g. the internal sales order id the customer use in their own system.

": "{String}",
10
          "volumePriceAgreement
VolumePriceAgreement

Special price agreement related to the quantity beeing ordered.

Possible domain values can be found here

": "{String}",
11
          "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}",
12
          "netWeight
NetWeight

The net weight of object (excluding packing meterial) in kilograms

": "{Decimal}",
13
          "grossMargin
GrossMargin

Gross margin of sale, calculated as an average of gross margin of all items at the time items are created and when the document is registered. Will not be recalculated if gross margin in items change afterwards

": "{Decimal}",
14
          "currency
Currency

Three character code following the ISO 4217 standard

Possible domain values can be found here

": "{String}",
15
          "hasAttachmentsToForward
HasAttachmentsToForward

Has attachements that will be included when forwarded to other transaction documents.

": "{Boolean}",
16
          "note
Note

Additional information regarding the object (free text). This note might be visible to customers/suppliers.

": "{String}",
17
          "shippingAddressAttention
ShippingAddressAttention

Attention of the shipping address. When changing shipping address, the ShippingAddressAttention will be overridden by the attention of the new shipping address.

": "{String}",
18
          "invoiceAddressAttention
InvoiceAddressAttention

Attention of the invoice address. When changing invoice address, the InvoiceAddressAttention will be overridden by the attention of the new invoice address.

": "{String}",
19
          "locationCountryCode
LocationCountryCode

Country code of the location. Inherits from the location.

": "{String}",
20
          "location": {
21
               "shortName
ShortName

Unique abbreviation/short name of the location

": {
22
                    "countryCode
CountryCode

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

": "{String}"
23
               }
24
          },
25
          "assignee
Assignee

The user who has been assigned to work with this object.

": {
26
               "userId
UserId

User identifier

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

Name of the user

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

First name of the user

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

User reference

": "{String}"
30
          },
31
          "validity": {
32
               "effectiveDate
EffectiveDate

The date the sales quote takes effect. The quote will be effective from from and including this date.

": "{Date}",
33
               "expirationDate
ExpirationDate

The date the sales quote expires. The quote will be active to and including this date.

": "{Date}"
34
          },
35
          "customer": {
36
               "customerId
CustomerId

Customer identifier

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

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

": "{String}",
38
               "firstname
Firstname

Secondary name of a company or firstname of a person

": "{String}",
39
               "sales": {
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
                    "marketSegment
MarketSegment

Market segment of the customer

Possible domain values can be found here

": {
42
                         "employeeId
EmployeeId

Employee identifier

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

Last name of employee

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

First name of employee

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

Employee reference

": "{String}",
46
                         "employeeId
EmployeeId

Employee identifier

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

Last name of employee

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

First name of employee

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

Employee reference

": "{String}"
50
                    }
51
               },
52
               "customerLegalEntity": {
53
                    "customerLegalEntityId
CustomerLegalEntityId

Customer legal entity identifier

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

Reference to customer legal entity

": "{String}"
55
               },
56
               "customerLink
CustomerLink

Customer reference

": "{String}"
57
          },
58
          "shippingAddress": {
59
               "addressId
AddressId

Address identifier

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

Name of receiver (Name of company or last name of a person). Note that default invoice address must have the same name as the customer.

": "{String}",
61
               "firstname
Firstname

Firstname if the receiver is a person. Note that default invoice address must have the same firstname as the customer.

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

First address line

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

Second address line

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

Postalcode/Postcode/ZIP

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

City/town/village

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

Region/province/state

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

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

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

English name of country.

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

External address identifier. Normally defined by the customer.

": "{String}"
70
          },
71
          "invoiceAddress": {
72
               "name
Name

Name of receiver (Name of company or last name of a person). Note that default invoice address must have the same name as the customer.

": "{String}",
73
               "firstname
Firstname

Firstname if the receiver is a person. Note that default invoice address must have the same firstname as the customer.

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

First address line

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

Second address line

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

Postalcode/Postcode/ZIP

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

City/town/village

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

Region/province/state

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

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

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

English name of country.

": "{String}"
81
          },
82
          "totals": {
83
               "currency
Currency

Three character code following the ISO 4217 standard

": "{String}",
84
               "freightAmount
FreightAmount

Freight amount in transaction document's currency

": "{Decimal}",
85
               "feeAmount
FeeAmount

Fee amount in transaction document's currency

": "{Decimal}",
86
               "subTotalAmount
SubTotalAmount

Total amount of the object in object currency, excluding VAT.

": "{Decimal}",
87
               "vATAmount
VATAmount

Total value added tax in object currency.

": "{Decimal}",
88
               "totalAmount
TotalAmount

The total amount in object currency, including VAT

": "{Decimal}",
89
               "currency
Currency

Currency used in conversion. Default is company accounting currency. Three character code following the ISO 4217 standard.

": "{String}",
90
               "exchangeRate
ExchangeRate

The exchange rate used in convertion

": "{Decimal}",
91
               "freightAmount
FreightAmount

Freight amount in company currency.

": "{Decimal}",
92
               "feeAmount
FeeAmount

Fee amount in company currency

": "{Decimal}",
93
               "subTotalAmount
SubTotalAmount

Total amount of the object in company currency, excluding VAT.

": "{Decimal}",
94
               "vATAmount
VATAmount

Value added tax amount in company currency.

": "{Decimal}",
95
               "totalAmount
TotalAmount

The total amount in company currency, including VAT.

": "{Decimal}"
96
          },
97
          "shipment": {
98
               "deliveryTerms
DeliveryTerms

Delivery terms when shipping the goods. The delivery terms is based on the Incoterms rules from ICC (International Chamber of Commerce). The delivery terms is by default retrieved from the customer.

Possible domain values can be found here

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

Named place related to delivery terms (Incoterms)

": "{String}",
100
               "onlyShipEntireSalesOrder
OnlyShipEntireSalesOrder

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}",
101
               "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}",
102
               "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}",
103
               "shipBasedOnConfirmedDeliveryDate
ShipBasedOnConfirmedDeliveryDate

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

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

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

": "{Boolean}",
105
               "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}",
106
               "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}",
107
               "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}",
108
               "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}",
109
               "specialHandling
SpecialHandling

Special handling to use for this shipment.

": {
110
                    "specialHandlingId
SpecialHandlingId

Special handling identifier

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

Special handling code reference

": "{String}"
112
               },
113
               "shippingService": {
114
                    "shippingServiceId
ShippingServiceId

Shipping service identifier

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

Name of shipping service

": "{String}",
116
                    "carrier": {
117
                         "carrierId
CarrierId

Carrier identifier

": "{Integer}",
118
                         "carrierLink
CarrierLink

Carrier reference

": "{String}"
119
                    },
120
                    "shippingServiceLink
ShippingServiceLink

Shipping service reference

": "{String}"
121
               }
122
          },
123
          "invoicing": {
124
               "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}",
125
               "salesInvoiceConsolidationField
SalesInvoiceConsolidationField

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

Possible domain values can be found here

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

Field name to sort by when creating sales invoice items.

Possible domain values can be found here

": "{String}"
127
          },
128
          "payment": {
129
               "paymentTerms
PaymentTerms

Terms of payment. Defaut value is retrieved from the customer. The due date of the sales order and sales invoice is calculated based on this field.

Possible domain values can be found here

": "{String}"
130
          },
131
          "salesOpportunity": {
132
               "salesOpportunityId
SalesOpportunityId

Sales opportunity identifier

": "{Integer}",
133
               "salesOpportunityLink
SalesOpportunityLink

Sales opportunity reference

": "{String}"
134
          },
135
          "vATDetails": {
136
               "vATType
VATType

Type of value added tax

": "{String}",
137
               "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}",
138
               "defaultVATPercent
DefaultVATPercent

Value added tax percent.

": "{Decimal}",
139
               "notificationId
NotificationId

Notification identifier

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

Status of the notification

Possible domain values can be found here

": "{Integer}",
141
               "createdAt
CreatedAt

Date and time of creation

": "{Datetime}",
142
               "message
Message

The message from the notification definition, expanded with parameters.

": "{String}",
143
               "translatedMessage
TranslatedMessage

The translated message from the notification definition, expanded with parameters.

": "{String}",
144
               "notificationType": {
145
                    "notificationTypeId
NotificationTypeId

Notification type identifier

": "{String}",
146
                    "category
Category

Category of notification type (warning, information etc)

Possible domain values can be found here

": "{String}",
147
                    "notificationTypeLink
NotificationTypeLink

Notification type reference

": "{String}"
148
               },
149
               "notificationLink
NotificationLink

Notification reference

": "{String}"
150
          }
151
     }
152
}

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 100048 HTTP 400 Parameter {0}: {1} not valid
Error 101492 HTTP 400 Illegal VAT code: VAT value > 0 is not allowed on this document
Error 101493 HTTP 400 Illegal update: New VAT code has VAT percentage different from old VAT code.
Error 101494 HTTP 400 Illegal VAT code: Vat code and document has different VAT number
Error 101496 HTTP 400 Illegal VAT code {0}: Check VAT FromPeriod and ToPeriod
Error 101495 HTTP 400 Illegal VAT code: {0}
Error 107641 HTTP 400 VAT code {0} has not an active VAT code setup
Error 100984 HTTP 400 Illegal update. The General ledger posting has ST>4
Error 100985 HTTP 400 Illegal update. The General ledger posting has AGIO-calculation
Error 108106 HTTP 400 Linking is not allowed for project order item which is based on expense log
Error 104971 HTTP 400 The start date cannot be later than the end date
Error 103491 HTTP 400 Invalid expiration date
Error 108262 HTTP 404 Recurring rate not found
Error 108691 HTTP 400 Recurring rate is not active
Error 108018 HTTP 400 Currency mismatch
Error 108016 HTTP 400 Product id mismatch
Error 108824 HTTP 400 Cannot apply recurring rate as it is not valid for selected period
Error 108671 HTTP 400 The effective date cannot be changed because earlier days have already been invoiced
Error 108684 HTTP 400 The expiration date cannot be changed because later days have already been invoiced
Error 108677 HTTP 400 Expected delivery date cannot be earlier than the effective date
Error 108678 HTTP 400 Expected collection date cannot be earlier than the effective date
Error 108679 HTTP 400 Expected collection date cannot be earlier then expected delivery date
Error 108680 HTTP 400 Collection date cannot be earlier then the effective date
Error 108681 HTTP 400 Collection date cannot be earlier then the expected delivery date
Error 108683 HTTP 400 Termination date must be earlier then the expiration date
Error 107278 HTTP 400 No available rental unit found for specified product and date range
Error 101007 HTTP 400 Cannot change product type from a virtual type to a physical type
Error 103021 HTTP 400 Linkid must be a rental product
Error 104760 HTTP 400 Costing method can't be changed after product has been received
Error 104652 HTTP 400 Both minimum sales price and minimum sales price currency must be given
Error 100563 HTTP 400 Currency {0} is not supported by the system
Error 104653 HTTP 400 Minimum sales price can not be negative
Error 106506 HTTP 404 Image not found