Sales APIs
Creates a new sales order request
| HTTP method | POST |
| URI | https://api.rambase.net/sales/order-requests |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| Custom fields | Custom fields supported |
| Successful HTTP status code | 201 |
| API resource identifier | 1909, version 7 |
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.
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>Location
This field is optional.
>LocationId
Location identifier
Minimum value: 10000
This field is optional.
>{Integer}</LocationId>CustomerId
Required/mandatory field
Customer identifier
Minimum value: 10000
>{Integer}</CustomerId>ShippingAddress
This field is optional.
>AddressId
Address identifier
Minimum value: 1
This field is optional.
>{Integer}</AddressId>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>ShippingService
This field is optional.
>ShippingServiceId
Shipping service identifier
Minimum value: 100000
This field is optional.
>{Integer}</ShippingServiceId>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>PaymentMethod
Method of payment. Default value is retrieved from the customer.
Applicable domain values can be found here
This field is optional.
>{String}</PaymentMethod>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>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}",Location
This field is optional.
": {LocationId
Location identifier
Minimum value: 10000
This field is optional.
": "{Integer}"CustomerId
Required/mandatory field
Customer identifier
Minimum value: 10000
": "{Integer}"ShippingAddress
This field is optional.
": {AddressId
Address identifier
Minimum value: 1
This field is optional.
": "{Integer}"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}",ShippingService
This field is optional.
": {ShippingServiceId
Shipping service identifier
Minimum value: 100000
This field is optional.
": "{Integer}"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}",PaymentMethod
Method of payment. Default value is retrieved from the customer.
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}"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.
SalesOrderRequestId
Sales order request identifier
>{Integer}</SalesOrderRequestId>Status
Status of sales order request
Possible domain values can be found here
>{Integer}</Status>CreatedAt
Date and time of creation
>{Datetime}</CreatedAt>RegistrationDate
Date of registration
>{Date}</RegistrationDate>SellersReferenceNumber
Sellers reference number.
>{String}</SellersReferenceNumber>CustomersReference
Customers reference. Typically a person.
>{String}</CustomersReference>CustomersReferenceNumber
Customers reference number. E.g. the internal sales order id the customer use in their own system.
>{String}</CustomersReferenceNumber>VolumePriceAgreement
Special price agreement related to the quantity beeing ordered.
Possible domain values can be found here
>{String}</VolumePriceAgreement>ExchangeRateFluctuationAgreement
When a sales order is issued, RamBase stores the current exchange rate and the currency the product normally is purchased in. The exchange rate might have changed when the invoice is issued. The exchange rate fluctuation agreement specifies how to handle these differences. The agreement has the format AAA/BBB, where AAA is a percentage of the total invoice, and BBB is the exchange rate fluctuation percentage. E.g. 100/3.0 means that if the rate of exchange on the date a sales order is forwarded to an invoice has changed more than +/- 3% from the rate of exchange, 100% of the invoice amount will be adjusted.
Possible domain values can be found here
>{String}</ExchangeRateFluctuationAgreement>NetWeight
The net weight of object (excluding packing meterial) in kilograms
>{Decimal}</NetWeight>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>Currency
Three character code following the ISO 4217 standard
Possible domain values can be found here
>{String}</Currency>HasAttachmentsToForward
Has attachements that will be included when forwarded to other transaction documents.
>{Boolean}</HasAttachmentsToForward>Note
Additional information regarding the object (free text). This note might be visible to customers/suppliers.
>{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.
>{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.
>{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.
>{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.
>{String}</InvoiceAddressAttention>ShortName
Unique abbreviation/short name of the location
>{String}</ShortName>Assignee
The user who has been assigned to work with this object.
>UserId
User identifier
>{Integer}</UserId>Name
Name of the user
>{String}</Name>FirstName
First name of the user
>{String}</FirstName>UserLink
User reference
>{String}</UserLink>CustomerId
Customer identifier
>{Integer}</CustomerId>Name
Name of customer (name of company or surname/familyname/lastname of a person)
>{String}</Name>Firstname
Secondary name of a company or firstname of a person
>{String}</Firstname>SalesDistrict
A geographic district for which an individual salesperson or sales team holds responsibility
Possible domain values can be found here
>{String}</SalesDistrict>MarketSegment
Market segment of the customer
Possible domain values can be found here
>EmployeeId
Employee identifier
>{Integer}</EmployeeId>LastName
Last name of employee
>{String}</LastName>FirstName
First name of employee
>{String}</FirstName>EmployeeLink
Employee reference
>{String}</EmployeeLink>EmployeeId
Employee identifier
>{Integer}</EmployeeId>LastName
Last name of employee
>{String}</LastName>FirstName
First name of employee
>{String}</FirstName>EmployeeLink
Employee reference
>{String}</EmployeeLink>CustomerLegalEntityId
Customer legal entity identifier
>{Integer}</CustomerLegalEntityId>CustomerLegalEntityLink
Reference to customer legal entity
>{String}</CustomerLegalEntityLink>CustomerLink
Customer reference
>{String}</CustomerLink>AddressId
Address identifier
>{Integer}</AddressId>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>Firstname
Firstname if the receiver is a person. Note that default invoice address must have the same firstname as the customer.
>{String}</Firstname>AddressLine1
First address line
>{String}</AddressLine1>AddressLine2
Second address line
>{String}</AddressLine2>PostalCode
Postalcode/Postcode/ZIP
>{String}</PostalCode>City
City/town/village
>{String}</City>Region
Region/province/state
>{String}</Region>CountryCode
Two-character code (ISO 3166) identifying the country.
>{String}</CountryCode>Country
English name of country.
>{String}</Country>ExternalReference
External address identifier. Normally defined by the customer.
>{String}</ExternalReference>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>Firstname
Firstname if the receiver is a person. Note that default invoice address must have the same firstname as the customer.
>{String}</Firstname>AddressLine1
First address line
>{String}</AddressLine1>AddressLine2
Second address line
>{String}</AddressLine2>PostalCode
Postalcode/Postcode/ZIP
>{String}</PostalCode>City
City/town/village
>{String}</City>Region
Region/province/state
>{String}</Region>CountryCode
Two-character code (ISO 3166) identifying the country.
>{String}</CountryCode>Country
English name of country.
>{String}</Country>Currency
Three character code following the ISO 4217 standard
>{String}</Currency>FreightAmount
Freight amount in transaction document's currency
>{Decimal}</FreightAmount>FeeAmount
Fee amount in transaction document's currency
>{Decimal}</FeeAmount>SubTotalAmount
Total amount of the object in object currency, excluding VAT.
>{Decimal}</SubTotalAmount>VATAmount
Total value added tax in object currency.
>{Decimal}</VATAmount>TotalAmount
The total amount in object currency, including VAT
>{Decimal}</TotalAmount>Currency
Currency used in conversion. Default is company accounting currency. Three character code following the ISO 4217 standard.
>{String}</Currency>ExchangeRate
The exchange rate used in convertion
>{Decimal}</ExchangeRate>FreightAmount
Freight amount in company currency.
>{Decimal}</FreightAmount>FeeAmount
Fee amount in company currency
>{Decimal}</FeeAmount>SubTotalAmount
Total amount of the object in company currency, excluding VAT.
>{Decimal}</SubTotalAmount>VATAmount
Value added tax amount in company currency.
>{Decimal}</VATAmount>TotalAmount
The total amount in company currency, including VAT.
>{Decimal}</TotalAmount>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>DeliveryTermPlace
Named place related to delivery terms (Incoterms)
>{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.
>{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.
>{Boolean}</OnlyShipEntireSalesOrderItems>AvoidMultipleShipmentsOnSameDate
True if all items of a sales order with the same sheduled delivery date should be shipped together. If sales order is forwarded to shipping advice by bulk handling, this will be controlled by RamBase. Manually forward requires that the users controls this themselves.
>{Boolean}</AvoidMultipleShipmentsOnSameDate>ShipBasedOnConfirmedDeliveryDate
If true, will sheduled shipping date on each item be calculated based on confirmed date rather than requested date.
>{Boolean}</ShipBasedOnConfirmedDeliveryDate>FreightForEachShipment
If unchecked there will only be calculated freight on one shipping advice if the particular sales order has serveral shipments.
>{Boolean}</FreightForEachShipment>ShippingDay
Specifies when the goods should be shipped. This is used to calculate the scheduled shipping date for each item.
Possible domain values can be found here
>{String}</ShippingDay>ConsolidateShippingAdvices
If true, sales orders will be consolidated when creating shipping advices via the "Prepare for picking" process the . If false, each sales order will result in seperate shipping advice. The field to use when consolidating is specified in the ShippingAdviceConsolidationField.
>{Boolean}</ConsolidateShippingAdvices>ShippingAdviceConsolidationField
Field to use when consolidating sales order items into shipping advices in the "Prepare for picking" process.
Possible domain values can be found here
>{String}</ShippingAdviceConsolidationField>ShippingAdviceItemSortBy
Items in consolidated shipping advices will be sorted by this fields when they are created in the 'Prepare for picking' process
Possible domain values can be found here
>{String}</ShippingAdviceItemSortBy>SpecialHandling
Special handling to use for this shipment.
>SpecialHandlingId
Special handling identifier
>{Integer}</SpecialHandlingId>SpecialHandlingLink
Special handling code reference
>{String}</SpecialHandlingLink>ShippingServiceId
Shipping service identifier
>{Integer}</ShippingServiceId>Name
Name of shipping service
>{String}</Name>CarrierId
Carrier identifier
>{Integer}</CarrierId>CarrierLink
Carrier reference
>{String}</CarrierLink>ShippingServiceLink
Shipping service reference
>{String}</ShippingServiceLink>SalesInvoiceConsolidation
Specifies whether or how often shipping advices that origins from this sales order will be consolidated when creating sales invoices.
Possible domain values can be found here
>{String}</SalesInvoiceConsolidation>SalesInvoiceConsolidationField
Field name to group by when consolidating shipping advice items into sales invoices.
Possible domain values can be found here
>{String}</SalesInvoiceConsolidationField>SalesInvoiceItemSortBy
Field name to sort by when creating sales invoice items.
Possible domain values can be found here
>{String}</SalesInvoiceItemSortBy>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>PaymentMethod
Method of payment. Default value is retrieved from the customer.
Possible domain values can be found here
>{String}</PaymentMethod>VATType
Type of value added tax
>{String}</VATType>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>DefaultVATPercent
Value added tax percent.
>{Decimal}</DefaultVATPercent>NotificationId
Notification identifier
>{Integer}</NotificationId>CreatedAt
Date and time of creation
>{Datetime}</CreatedAt>Message
The message from the notification definition, expanded with parameters.
>{String}</Message>TranslatedMessage
The translated message from the notification definition, expanded with parameters.
>{String}</TranslatedMessage>NotificationTypeId
Notification type identifier
>{String}</NotificationTypeId>Category
Category of notification type (warning, information etc)
Possible domain values can be found here
>{String}</Category>NotificationTypeLink
Notification type reference
>{String}</NotificationTypeLink>NotificationLink
Notification reference
>{String}</NotificationLink>SalesOrderRequestId
Sales order request identifier
": "{Integer}",Status
Status of sales order request
Possible domain values can be found here
": "{Integer}",CreatedAt
Date and time of creation
": "{Datetime}",RegistrationDate
Date of registration
": "{Date}",SellersReferenceNumber
Sellers reference number.
": "{String}",CustomersReference
Customers reference. Typically a person.
": "{String}",CustomersReferenceNumber
Customers reference number. E.g. the internal sales order id the customer use in their own system.
": "{String}",VolumePriceAgreement
Special price agreement related to the quantity beeing ordered.
Possible domain values can be found here
": "{String}",ExchangeRateFluctuationAgreement
When a sales order is issued, RamBase stores the current exchange rate and the currency the product normally is purchased in. The exchange rate might have changed when the invoice is issued. The exchange rate fluctuation agreement specifies how to handle these differences. The agreement has the format AAA/BBB, where AAA is a percentage of the total invoice, and BBB is the exchange rate fluctuation percentage. E.g. 100/3.0 means that if the rate of exchange on the date a sales order is forwarded to an invoice has changed more than +/- 3% from the rate of exchange, 100% of the invoice amount will be adjusted.
Possible domain values can be found here
": "{String}",NetWeight
The net weight of object (excluding packing meterial) in kilograms
": "{Decimal}",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}",Currency
Three character code following the ISO 4217 standard
Possible domain values can be found here
": "{String}",HasAttachmentsToForward
Has attachements that will be included when forwarded to other transaction documents.
": "{Boolean}",Note
Additional information regarding the object (free text). This note might be visible to customers/suppliers.
": "{String}",ShippingAddressAttention
Attention of the shipping address. When changing shipping address, the ShippingAddressAttention will be overridden by the attention of the new shipping address.
": "{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.
": "{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.
": "{String}",InvoiceAddressAttention
Attention of the invoice address. When changing invoice address, the InvoiceAddressAttention will be overridden by the attention of the new invoice address.
": "{String}",ShortName
Unique abbreviation/short name of the location
": "{String}"Assignee
The user who has been assigned to work with this object.
": {UserId
User identifier
": "{Integer}",Name
Name of the user
": "{String}",FirstName
First name of the user
": "{String}",UserLink
User reference
": "{String}"CustomerId
Customer identifier
": "{Integer}",Name
Name of customer (name of company or surname/familyname/lastname of a person)
": "{String}",Firstname
Secondary name of a company or firstname of a person
": "{String}",SalesDistrict
A geographic district for which an individual salesperson or sales team holds responsibility
Possible domain values can be found here
": "{String}",MarketSegment
Market segment of the customer
Possible domain values can be found here
": {EmployeeId
Employee identifier
": "{Integer}",LastName
Last name of employee
": "{String}",FirstName
First name of employee
": "{String}",EmployeeLink
Employee reference
": "{String}",EmployeeId
Employee identifier
": "{Integer}",LastName
Last name of employee
": "{String}",FirstName
First name of employee
": "{String}",EmployeeLink
Employee reference
": "{String}"CustomerLegalEntityId
Customer legal entity identifier
": "{Integer}",CustomerLegalEntityLink
Reference to customer legal entity
": "{String}"CustomerLink
Customer reference
": "{String}"AddressId
Address identifier
": "{Integer}",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}",Firstname
Firstname if the receiver is a person. Note that default invoice address must have the same firstname as the customer.
": "{String}",AddressLine1
First address line
": "{String}",AddressLine2
Second address line
": "{String}",PostalCode
Postalcode/Postcode/ZIP
": "{String}",City
City/town/village
": "{String}",Region
Region/province/state
": "{String}",CountryCode
Two-character code (ISO 3166) identifying the country.
": "{String}",Country
English name of country.
": "{String}",ExternalReference
External address identifier. Normally defined by the customer.
": "{String}"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}",Firstname
Firstname if the receiver is a person. Note that default invoice address must have the same firstname as the customer.
": "{String}",AddressLine1
First address line
": "{String}",AddressLine2
Second address line
": "{String}",PostalCode
Postalcode/Postcode/ZIP
": "{String}",City
City/town/village
": "{String}",Region
Region/province/state
": "{String}",CountryCode
Two-character code (ISO 3166) identifying the country.
": "{String}",Country
English name of country.
": "{String}"Currency
Three character code following the ISO 4217 standard
": "{String}",FreightAmount
Freight amount in transaction document's currency
": "{Decimal}",FeeAmount
Fee amount in transaction document's currency
": "{Decimal}",SubTotalAmount
Total amount of the object in object currency, excluding VAT.
": "{Decimal}",VATAmount
Total value added tax in object currency.
": "{Decimal}",TotalAmount
The total amount in object currency, including VAT
": "{Decimal}",Currency
Currency used in conversion. Default is company accounting currency. Three character code following the ISO 4217 standard.
": "{String}",ExchangeRate
The exchange rate used in convertion
": "{Decimal}",FreightAmount
Freight amount in company currency.
": "{Decimal}",FeeAmount
Fee amount in company currency
": "{Decimal}",SubTotalAmount
Total amount of the object in company currency, excluding VAT.
": "{Decimal}",VATAmount
Value added tax amount in company currency.
": "{Decimal}",TotalAmount
The total amount in company currency, including VAT.
": "{Decimal}"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}",DeliveryTermPlace
Named place related to delivery terms (Incoterms)
": "{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.
": "{Boolean}",OnlyShipEntireSalesOrderItems
True if the total quantity of a sales order item always should be shipped together. The quantity should never be split into several shipments. If sales order is forwarded to shipping advice by bulk handling, this will be controlled by RamBase. Manually forward requires that the users controls this themselves.
": "{Boolean}",AvoidMultipleShipmentsOnSameDate
True if all items of a sales order with the same sheduled delivery date should be shipped together. If sales order is forwarded to shipping advice by bulk handling, this will be controlled by RamBase. Manually forward requires that the users controls this themselves.
": "{Boolean}",ShipBasedOnConfirmedDeliveryDate
If true, will sheduled shipping date on each item be calculated based on confirmed date rather than requested date.
": "{Boolean}",FreightForEachShipment
If unchecked there will only be calculated freight on one shipping advice if the particular sales order has serveral shipments.
": "{Boolean}",ShippingDay
Specifies when the goods should be shipped. This is used to calculate the scheduled shipping date for each item.
Possible domain values can be found here
": "{String}",ConsolidateShippingAdvices
If true, sales orders will be consolidated when creating shipping advices via the "Prepare for picking" process the . If false, each sales order will result in seperate shipping advice. The field to use when consolidating is specified in the ShippingAdviceConsolidationField.
": "{Boolean}",ShippingAdviceConsolidationField
Field to use when consolidating sales order items into shipping advices in the "Prepare for picking" process.
Possible domain values can be found here
": "{String}",ShippingAdviceItemSortBy
Items in consolidated shipping advices will be sorted by this fields when they are created in the 'Prepare for picking' process
Possible domain values can be found here
": "{String}",SpecialHandling
Special handling to use for this shipment.
": {SpecialHandlingId
Special handling identifier
": "{Integer}",SpecialHandlingLink
Special handling code reference
": "{String}"ShippingServiceId
Shipping service identifier
": "{Integer}",Name
Name of shipping service
": "{String}",CarrierId
Carrier identifier
": "{Integer}",CarrierLink
Carrier reference
": "{String}"ShippingServiceLink
Shipping service reference
": "{String}"SalesInvoiceConsolidation
Specifies whether or how often shipping advices that origins from this sales order will be consolidated when creating sales invoices.
Possible domain values can be found here
": "{String}",SalesInvoiceConsolidationField
Field name to group by when consolidating shipping advice items into sales invoices.
Possible domain values can be found here
": "{String}",SalesInvoiceItemSortBy
Field name to sort by when creating sales invoice items.
Possible domain values can be found here
": "{String}"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}",PaymentMethod
Method of payment. Default value is retrieved from the customer.
Possible domain values can be found here
": "{String}"VATType
Type of value added tax
": "{String}",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}",DefaultVATPercent
Value added tax percent.
": "{Decimal}",NotificationId
Notification identifier
": "{Integer}",Status
Status of the notification
Possible domain values can be found here
": "{Integer}",CreatedAt
Date and time of creation
": "{Datetime}",Message
The message from the notification definition, expanded with parameters.
": "{String}",TranslatedMessage
The translated message from the notification definition, expanded with parameters.
": "{String}",NotificationTypeId
Notification type identifier
": "{String}",Category
Category of notification type (warning, information etc)
Possible domain values can be found here
": "{String}",NotificationTypeLink
Notification type reference
": "{String}"NotificationLink
Notification reference
": "{String}"
List of available operations/actions for this resource.
See the operations documentation for more information about API operations.
Possible error codes the response might return:
| Error 102447 HTTP 400 | Missing both assignment id and item id parameters. |
| Error 102012 HTTP 400 | Transcation Object ID is required |
| Error 100563 HTTP 400 | Currency {0} is not supported by the system |
| Error 101488 HTTP 400 | Illegal general ledger account : {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} |