Logistics APIs
Saves information about shipping advice
| HTTP method | PUT |
| URI | https://api.rambase.net/logistics/shipping-advices/{shippingAdviceId} |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| - URI parameter {shippingAdviceId} |
Shipping advice identifier
Integer, minimum 100000 |
| Custom fields | Custom fields supported |
| Successful HTTP status code | 200 |
| API resource identifier | 2063, version 24 |
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.
ShippingAdvice
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>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>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>Assignee
The user who has been assigned to work with this object.
This field is optional.
>UserId
User identifier
This field is optional.
>{Integer}</UserId>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.
>Priority
Priority of the shipment
Applicable domain values can be found here
This field is optional.
>{Integer}</Priority>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
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>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>ShippingAdvice
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}",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}",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}",Assignee
The user who has been assigned to work with this object.
This field is optional.
": {UserId
User identifier
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.
": {Priority
Priority of the shipment
Applicable domain values can be found here
This field is optional.
": "{Integer}",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
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}"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 100048 HTTP 400 | Parameter {0}: {1} not valid |
| Error 105428 HTTP 400 | FromPeriod cannot be changed when correction has been done |
| Error 105430 HTTP 400 | FromPeriod is not valid |
| Error 107325 HTTP 400 | This file is externally owned and cannot be linked to any other customer or supplier. |
| Error 107320 HTTP 400 | Already exists rental unit with selected serial number. |
| Error 109293 HTTP 400 | It is not allowed to assign a fixed asset to a rental unit owned by a third party |
| Error 103939 HTTP 404 | Fixes asset not found |
| Error 109688 HTTP 400 | You can only link fixed asset of investment type Rental |
| Error 109170 HTTP 400 | The selected fixed asset is already assigned to a rental unit. You cannot assign the same fixed asset multiple times. |
| Error 101235 HTTP 404 | Goods reception item {0} not found |
| Error 107276 HTTP 400 | Serial number of registered rental unit cannot be modified |
| Error 109482 HTTP 400 | The availability start date for non-owners must not precede the rental unit's availability date |
| Error 109483 HTTP 400 | The end date of availability for non-owners cannot be later than the end date of the rental unit |
| Error 108672 HTTP 400 | Closing date cannot be earlier then the effective date |
| Error 108969 HTTP 400 | The selected default check-out location ({0}) is not active |
| Error 108970 HTTP 400 | The selected default check-out location ({0}) is not a rental depot capable location |
| Error 109723 HTTP 400 | The country of selected default check-out location ({0}) is different than contract's main location country ({1}) |
| Error 108971 HTTP 400 | The selected default check-in location ({0}) is not active |
| Error 108972 HTTP 400 | The selected default check-in location ({0}) is not a rental depot capable location |
| Error 109724 HTTP 400 | The country of selected default check-in location ({0}) is different than contract's main location country ({1}) |
| Error 109335 HTTP 400 | Selected payment term is not supported on rental contract |
| Error 108670 HTTP 400 | Discount percentage must be a number between 0 and 100 |
| Error 109623 HTTP 400 | VAT handling can't be changed since there has been made invoice(s) from this contract |
| Error 108679 HTTP 400 | Expected check-in date cannot be earlier then expected check-out 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 108683 HTTP 400 | Termination date must be earlier then the expiration date |
| Error 109306 HTTP 400 | Shipping details can only be updated until an item is shipped |