API

Logistics APIs

PUT logistics/shipping-advices/{shippingAdviceId}

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 16

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
<ShippingAdvice
ShippingAdvice

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
     <ExchangeRateFluctuationAgreement
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>
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
     <ShippingAddressPhone
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>
8
     <ShippingAddressEmail
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>
9
     <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>
10
     <Assignee
Assignee

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

This field is optional.

>
11
          <UserId
UserId

User identifier

This field is optional.

>{Integer}</UserId>
12
     </Assignee>
13
     <ShippingAddress
ShippingAddress

This field is optional.

>
14
          <AddressId
AddressId

Address identifier

Minimum value: 1

This field is optional.

>{Integer}</AddressId>
15
     </ShippingAddress>
16
     <Totals
Totals

This field is optional.

>
17
          <FeeAmount
FeeAmount

Fee amount in transaction document's currency

Minimum value: 0

This field is optional.

>{Decimal}</FeeAmount>
18
          <FreightAmount
FreightAmount

Freight amount in transaction document's currency

Minimum value: 0

This field is optional.

>{Decimal}</FreightAmount>
19
     </Totals>
20
     <Shipment
Shipment

This field is optional.

>
21
          <Priority
Priority

Priority of the shipment

Applicable domain values can be found here

This field is optional.

>{Integer}</Priority>
22
          <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>
23
          <DeliveryTermPlace
DeliveryTermPlace

Named place related to delivery terms (Incoterms)

This field is optional.

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

This field is optional.

>
25
               <ShippingServiceId
ShippingServiceId

Shipping service identifier

This field is optional.

>{Integer}</ShippingServiceId>
26
          </ShippingService>
27
     </Shipment>
28
     <Invoicing
Invoicing

This field is optional.

>
29
          <SalesInvoiceConsolidation
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>
30
          <SalesInvoiceConsolidationField
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>
31
          <SalesInvoiceItemSortBy
SalesInvoiceItemSortBy

Field name to sort by when creating sales invoice items.

Applicable domain values can be found here

This field is optional.

>{String}</SalesInvoiceItemSortBy>
32
     </Invoicing>
33
     <Payment
Payment

This field is optional.

>
34
          <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>
35
     </Payment>
36
     <VATDetails
VATDetails

This field is optional.

>
37
          <VATHandling
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>
38
     </VATDetails>
39
</ShippingAdvice>
1
{
2
     "shippingAdvice
ShippingAdvice

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
          "exchangeRateFluctuationAgreement
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}",
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
          "shippingAddressPhone
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}",
9
          "shippingAddressEmail
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}",
10
          "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}",
11
          "assignee
Assignee

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

This field is optional.

": {
12
               "userId
UserId

User identifier

This field is optional.

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

This field is optional.

": {
15
               "addressId
AddressId

Address identifier

Minimum value: 1

This field is optional.

": "{Integer}"
16
          },
17
          "totals
Totals

This field is optional.

": {
18
               "feeAmount
FeeAmount

Fee amount in transaction document's currency

Minimum value: 0

This field is optional.

": "{Decimal}",
19
               "freightAmount
FreightAmount

Freight amount in transaction document's currency

Minimum value: 0

This field is optional.

": "{Decimal}"
20
          },
21
          "shipment
Shipment

This field is optional.

": {
22
               "priority
Priority

Priority of the shipment

Applicable domain values can be found here

This field is optional.

": "{Integer}",
23
               "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}",
24
               "deliveryTermPlace
DeliveryTermPlace

Named place related to delivery terms (Incoterms)

This field is optional.

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

This field is optional.

": {
26
                    "shippingServiceId
ShippingServiceId

Shipping service identifier

This field is optional.

": "{Integer}"
27
               }
28
          },
29
          "invoicing
Invoicing

This field is optional.

": {
30
               "salesInvoiceConsolidation
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}",
31
               "salesInvoiceConsolidationField
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}",
32
               "salesInvoiceItemSortBy
SalesInvoiceItemSortBy

Field name to sort by when creating sales invoice items.

Applicable domain values can be found here

This field is optional.

": "{String}"
33
          },
34
          "payment
Payment

This field is optional.

": {
35
               "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}"
36
          },
37
          "vATDetails
VATDetails

This field is optional.

": {
38
               "vATHandling
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}"
39
          }
40
     }
41
}

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 103366 HTTP 404 Production resource group not found.
Error 101254 HTTP 400 Only articles with matching PARTNERID can be purchased from this supplier
Error 100475 HTTP 400 Project number is mandatory on all items.
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}