Sales APIs
Saves information about the sales order
| HTTP method | PUT |
| URI | https://api.rambase.net/sales/orders/{salesOrderId} |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| - URI parameter {salesOrderId} |
Sales order identifier
Integer, minimum 100000 |
| Custom fields | Custom fields supported |
| Successful HTTP status code | 200 |
| API resource identifier | 1869, version 52 |
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.
SalesOrder
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>ShippingAddressPhone
Phone number of the shipping address. When changing shipping address, the ShippingAddressPhone will be overridden by the phone number of the new shipping address.
Input must match the following regular expression pattern: ^([0-9\(\)\s\.\+\-])*$
This field is optional.
>{String}</ShippingAddressPhone>ShippingAddressEmail
Email address of the shipping address. When changing shipping address, the ShippingAddressEmail will be overridden by the email of the new shipping address.
Input must match the following regular expression pattern: ^\w+([-+.']\w+)*@\w+([-.]\w+)*\.\w+([-.]\w+)*$
This field is optional.
>{String}</ShippingAddressEmail>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>Customer
This field is optional.
>CustomerId
Customer identifier
Minimum value: 10000
This field is optional.
>{Integer}</CustomerId>Management
Represents a group of users, which are assigned to particular management roles.
This field is optional.
>Planner
Reference to the employee who is a production management planner.
This field is optional.
>EmployeeId
Employee identifier
Minimum value: 100
This field is optional.
>{Integer}</EmployeeId>ProjectLeader
Reference to the employee who is a production management project leader.
This field is optional.
>EmployeeId
Employee identifier
Minimum value: 100
This field is optional.
>{Integer}</EmployeeId>DocumentController
Reference to the employee who is a production management document controller.
This field is optional.
>EmployeeId
Employee identifier
Minimum value: 100
This field is optional.
>{Integer}</EmployeeId>ShippingAddress
This field is optional.
>AddressId
Address identifier
Minimum value: 1
This field is optional.
>{Integer}</AddressId>InvoiceAddress
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.
>PaymentMethod
Method of payment. Default value is retrieved from the customer.
Applicable domain values can be found here
This field is optional.
>{String}</PaymentMethod>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>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>UseStandardVATNumberRules
Do not automatically replace the VAT number based on the location configuration
This field is optional.
>{Boolean}</UseStandardVATNumberRules>SalesOrder
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}",ShippingAddressPhone
Phone number of the shipping address. When changing shipping address, the ShippingAddressPhone will be overridden by the phone number of the new shipping address.
Input must match the following regular expression pattern: ^([0-9\(\)\s\.\+\-])*$
This field is optional.
": "{String}",ShippingAddressEmail
Email address of the shipping address. When changing shipping address, the ShippingAddressEmail will be overridden by the email of the new shipping address.
Input must match the following regular expression pattern: ^\w+([-+.']\w+)*@\w+([-.]\w+)*\.\w+([-.]\w+)*$
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}"Customer
This field is optional.
": {CustomerId
Customer identifier
Minimum value: 10000
This field is optional.
": "{Integer}"Management
Represents a group of users, which are assigned to particular management roles.
This field is optional.
": {Planner
Reference to the employee who is a production management planner.
This field is optional.
": {EmployeeId
Employee identifier
Minimum value: 100
This field is optional.
": "{Integer}"ProjectLeader
Reference to the employee who is a production management project leader.
This field is optional.
": {EmployeeId
Employee identifier
Minimum value: 100
This field is optional.
": "{Integer}"DocumentController
Reference to the employee who is a production management document controller.
This field is optional.
": {EmployeeId
Employee identifier
Minimum value: 100
This field is optional.
": "{Integer}"ShippingAddress
This field is optional.
": {AddressId
Address identifier
Minimum value: 1
This field is optional.
": "{Integer}"InvoiceAddress
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.
": {PaymentMethod
Method of payment. Default value is retrieved from the customer.
Applicable domain values can be found here
This field is optional.
": "{String}",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}"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}",UseStandardVATNumberRules
Do not automatically replace the VAT number based on the location configuration
This field is optional.
": "{Boolean}"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 108477 HTTP 400 | Format of end customers order number is incorrect |
| Error 100854 HTTP 400 | Cannot change production start after operation is started |
| Error 101538 HTTP 400 | Date-field can not be blank |
| Error 103797 HTTP 400 | Mandatory field department has no value, please select |
| Error 104486 HTTP 400 | Unit production is only allowed for measurment units (UNI) of type QTY |
| Error 100316 HTTP 400 | Quantity cannot exceed {0} on UNIT productions |
| Error 104522 HTTP 400 | Location in goods reception must be equal to location in arriving waybill |
| Error 101466 HTTP 400 | Cannot change the location short code because of the object's status |
| Error 103023 HTTP 400 | You cannot changes location as purchase order is not prepared for direct/back to back shipment. |
| Error 103024 HTTP 400 | You cannot change location in a purchase order which is set up for direct/back to back shipment. |
| Error 103025 HTTP 400 | You cannot change location in a purchase order that is assigned to a sales order which is direct shipment/back to back sales order. |
| Error 101556 HTTP 400 | You can not change currency when order items have been added |
| Error 101562 HTTP 400 | This currency is not supported by the supplier |
| Error 101689 HTTP 400 | You cannot change this purchase order to type 'REQUISITION' as it contains standard products (type not equal to X or V). |
| Error 101690 HTTP 400 | You cannot change this purchase order to type 'REQUISITION' as it has assignments. |
| Error 101470 HTTP 400 | Cannot change currency on an object that contains items |
| Error 101464 HTTP 400 | Currency field can not be blank. |
| Error 101469 HTTP 400 | The object is not open for edit. To change currency, the object must be in status 1. |
| Error 100992 HTTP 400 | This customer does not buy in this currency |
| Error 101541 HTTP 400 | Cannot change volume price agreement when the object has items |
| Error 101588 HTTP 400 | Effective date must have a date that is earlier or equal to expiration date |
| Error 101589 HTTP 400 | The expiration date must be later or equal to effective date |
| Error 102521 HTTP 400 | The content of the CASE-field on one of this Orders items exists on another Order outside the project. |
| Error 106111 HTTP 400 | Delivery project PRO/{1} have finance project PRJ/{0}. COA item {2} is already linked to finance project PRJ/{3}. |
| Error 100276 HTTP 400 | Invalid email format |
| Error 106993 HTTP 400 | It is not allowed to add fee to the internal sales order for material for project order. |
| Error 106994 HTTP 400 | It is not allowed to add freight to a sales order for material for project order. |