Sales APIs
Update information for provided sales quote
| HTTP method | PUT |
| URI | https://api.rambase.net/sales/quotes/{salesQuoteId} |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| - URI parameter {salesQuoteId} |
Sales quote identifier
Integer, minimum 100000 |
| Custom fields | Custom fields supported |
| Successful HTTP status code | 200 |
| API resource identifier | 2048, version 23 |
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.
SalesQuote
This field is optional.
>CustomersReference
Customers reference. Typically a person.
This field is optional.
>{String}</CustomersReference>CustomersReferenceNumber
Customers reference number. E.g. the internal sales order id the customer use in their own system.
This field is optional.
>{String}</CustomersReferenceNumber>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>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>Note
Additional information regarding the object (free text). This note might be visible to customers/suppliers.
This field is optional.
>{String}</Note>ShippingAddressAttention
Attention of the shipping address. When changing shipping address, the ShippingAddressAttention will be overridden by the attention of the new shipping address.
This field is optional.
>{String}</ShippingAddressAttention>InvoiceAddressAttention
Attention of the invoice address. When changing invoice address, the InvoiceAddressAttention will be overridden by the attention of the new invoice address.
This field is optional.
>{String}</InvoiceAddressAttention>Location
This field is optional.
>LocationId
Location identifier
Minimum value: 10000
This field is optional.
>{Integer}</LocationId>Assignee
The user who has been assigned to work with this object.
This field is optional.
>UserId
User identifier
Minimum value: 100
This field is optional.
>{Integer}</UserId>Validity
This field is optional.
>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>ExpirationDate
The date the sales quote expires. The quote will be active to and including this date.
This field is optional.
>{Date}</ExpirationDate>Customer
This field is optional.
>CustomerId
Customer identifier
Minimum value: 10000
This field is optional.
>{Integer}</CustomerId>ShippingAddress
This field is optional.
>AddressId
Address identifier
Minimum value: 1
This field is optional.
>{Integer}</AddressId>Totals
This field is optional.
>FeeAmount
Fee amount in transaction document's currency
Minimum value: 0
This field is optional.
>{Decimal}</FeeAmount>FreightAmount
Freight amount in transaction document's currency
Minimum value: 0
This field is optional.
>{Decimal}</FreightAmount>Shipment
This field is optional.
>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>DeliveryTermPlace
Named place related to delivery terms (Incoterms)
This field is optional.
>{String}</DeliveryTermPlace>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.
This field is optional.
>{Boolean}</OnlyShipEntireSalesOrder>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>SpecialHandling
Special handling to use for this shipment.
This field is optional.
>SpecialHandlingId
Special handling identifier
This field is optional.
>{Integer}</SpecialHandlingId>ShippingService
This field is optional.
>ShippingServiceId
Shipping service identifier
This field is optional.
>{Integer}</ShippingServiceId>Invoicing
This field is optional.
>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>Payment
This field is optional.
>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>SalesOpportunity
This field is optional.
>SalesOpportunityId
Sales opportunity identifier
Minimum value: 100000
This field is optional.
>{Integer}</SalesOpportunityId>VATDetails
This field is optional.
>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>SalesQuote
This field is optional.
": {CustomersReference
Customers reference. Typically a person.
This field is optional.
": "{String}",CustomersReferenceNumber
Customers reference number. E.g. the internal sales order id the customer use in their own system.
This field is optional.
": "{String}",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}",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}",Note
Additional information regarding the object (free text). This note might be visible to customers/suppliers.
This field is optional.
": "{String}",ShippingAddressAttention
Attention of the shipping address. When changing shipping address, the ShippingAddressAttention will be overridden by the attention of the new shipping address.
This field is optional.
": "{String}",InvoiceAddressAttention
Attention of the invoice address. When changing invoice address, the InvoiceAddressAttention will be overridden by the attention of the new invoice address.
This field is optional.
": "{String}",Location
This field is optional.
": {LocationId
Location identifier
Minimum value: 10000
This field is optional.
": "{Integer}"Assignee
The user who has been assigned to work with this object.
This field is optional.
": {UserId
User identifier
Minimum value: 100
This field is optional.
": "{Integer}"Validity
This field is optional.
": {EffectiveDate
The date the sales quote takes effect. The quote will be effective from from and including this date.
This field is optional.
": "{Date}",ExpirationDate
The date the sales quote expires. The quote will be active to and including this date.
This field is optional.
": "{Date}"Customer
This field is optional.
": {CustomerId
Customer identifier
Minimum value: 10000
This field is optional.
": "{Integer}"ShippingAddress
This field is optional.
": {AddressId
Address identifier
Minimum value: 1
This field is optional.
": "{Integer}"Totals
This field is optional.
": {FeeAmount
Fee amount in transaction document's currency
Minimum value: 0
This field is optional.
": "{Decimal}",FreightAmount
Freight amount in transaction document's currency
Minimum value: 0
This field is optional.
": "{Decimal}"Shipment
This field is optional.
": {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}",DeliveryTermPlace
Named place related to delivery terms (Incoterms)
This field is optional.
": "{String}",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.
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}",SpecialHandling
Special handling to use for this shipment.
This field is optional.
": {SpecialHandlingId
Special handling identifier
This field is optional.
": "{Integer}"ShippingService
This field is optional.
": {ShippingServiceId
Shipping service identifier
This field is optional.
": "{Integer}"Invoicing
This field is optional.
": {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}"Payment
This field is optional.
": {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}"SalesOpportunity
This field is optional.
": {SalesOpportunityId
Sales opportunity identifier
Minimum value: 100000
This field is optional.
": "{Integer}"VATDetails
This field is optional.
": {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}"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 102190 HTTP 404 | Missing mandatory parameter for pick operation id |
| Error 102187 HTTP 400 | Missing mandatory parameter for goods reception database |
| Error 102188 HTTP 400 | Missing mandatory parameter for goods reception id |
| Error 102189 HTTP 400 | Missing mandatory parameter for goods reception item id |
| 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 |