API

Sales APIs

PUT sales/quote-requests/{salesQuoteRequestId}

Saves update information for provided sales quote request

HTTP method PUT
URI https://api.rambase.net/sales/quote-requests/{salesQuoteRequestId}
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {salesQuoteRequestId} Sales quote request identifier
Integer, minimum 100000
Custom fields Custom fields supported
Successful HTTP status code 200
API resource identifier 2045, 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
<SalesQuoteRequest
SalesQuoteRequest

This field is optional.

>
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
     <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>
5
     <Note
Note

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

This field is optional.

>{String}</Note>
6
     <ShippingAddressAttention
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>
7
     <InvoiceAddressAttention
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>
8
     <Assignee
Assignee

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

This field is optional.

>
9
          <UserId
UserId

User identifier

This field is optional.

>{Integer}</UserId>
10
     </Assignee>
11
     <Customer
Customer

This field is optional.

>
12
          <CustomerId
CustomerId

Customer identifier

Minimum value: 10000

This field is optional.

>{Integer}</CustomerId>
13
     </Customer>
14
     <ShippingAddress
ShippingAddress

This field is optional.

>
15
          <AddressId
AddressId

Address identifier

Minimum value: 1

This field is optional.

>{Integer}</AddressId>
16
     </ShippingAddress>
17
     <Shipment
Shipment

This field is optional.

>
18
          <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>
19
          <DeliveryTermPlace
DeliveryTermPlace

Named place related to delivery terms (Incoterms)

This field is optional.

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

This field is optional.

>
21
               <ShippingServiceId
ShippingServiceId

Shipping service identifier

This field is optional.

>{Integer}</ShippingServiceId>
22
          </ShippingService>
23
     </Shipment>
24
     <Payment
Payment

This field is optional.

>
25
          <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>
26
     </Payment>
27
</SalesQuoteRequest>
1
{
2
     "salesQuoteRequest
SalesQuoteRequest

This field is optional.

": {
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
          "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}",
6
          "note
Note

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

This field is optional.

": "{String}",
7
          "shippingAddressAttention
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}",
8
          "invoiceAddressAttention
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}",
9
          "assignee
Assignee

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

This field is optional.

": {
10
               "userId
UserId

User identifier

This field is optional.

": "{Integer}"
11
          },
12
          "customer
Customer

This field is optional.

": {
13
               "customerId
CustomerId

Customer identifier

Minimum value: 10000

This field is optional.

": "{Integer}"
14
          },
15
          "shippingAddress
ShippingAddress

This field is optional.

": {
16
               "addressId
AddressId

Address identifier

Minimum value: 1

This field is optional.

": "{Integer}"
17
          },
18
          "shipment
Shipment

This field is optional.

": {
19
               "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}",
20
               "deliveryTermPlace
DeliveryTermPlace

Named place related to delivery terms (Incoterms)

This field is optional.

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

This field is optional.

": {
22
                    "shippingServiceId
ShippingServiceId

Shipping service identifier

This field is optional.

": "{Integer}"
23
               }
24
          },
25
          "payment
Payment

This field is optional.

": {
26
               "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}"
27
          }
28
     }
29
}

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.

Format:
1
1

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 100202 HTTP 404 Payable journal entry not found
Error 102750 HTTP 400 Number of parameter values does not match the number of parameters in the formula
Error 102749 HTTP 400 Missing parameter value for parameter {0}
Error 102747 HTTP 400 Error in formula: {0}
Error 105186 HTTP 400 Postings are not allowed on control accounts.
Error 101490 HTTP 400 Illegal Account {0}: This account has been blocked for {1}-documents
Error 101491 HTTP 400 Illegal Account {0}: Check the account's FromPeriod and ToPeriod
Error 101517 HTTP 400 Illegal Account {0}: This account require ICTDB.
Error 102482 HTTP 400 Department is required for general ledger account {0}
Error 102483 HTTP 400 Finance project is required for general ledger account {0}
Error 102484 HTTP 400 Asset is required for general ledger account {0}
Error 102485 HTTP 400 Dimension {0} ({1}) is required for general ledger account {2}
Error 101313 HTTP 400 Department number is not valid: {0}
Error 101320 HTTP 400 The project number is not valid: {0}
Error 101500 HTTP 400 Project {0} could not be used : Check project FromPeriod and ToPeriod.
Error 101501 HTTP 400 Asset is not allowed on general ledger account {0}
Error 101326 HTTP 400 The asset number is not valid : {0}
Error 102486 HTTP 400 Invalid value for dimension {0}